JAMS Developer Guide
Folder Class Properties


MVPSI.JAMS Namespace : Folder Class

For a list of all members of this type, see Folder members.

Public Properties
 NameDescription
Public PropertyACLAccess Control List  
Public PropertyBatchQueueGets the batch queue that Jobs within the Folder should be submitted to.  
Public PropertyBatchQueueNameGets the name of the batch queue that Jobs within the Folder should be submitted to.  
Public PropertyDescriptionA description of this Folder.  
Public PropertyElementsA collection of components which apply to jobs in this folder.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyExecuteAsGets the default Credentials for Jobs in this Folder.  
Public PropertyExecuteAsIDGets and Sets the ID of the default Credentials for jobs in this Folder. This property is designed to be used by JAMS, not user code.  
Public PropertyExecuteAsNameGets the username of the default Credentials for Jobs in this Folder.  
Public PropertyFolderIDThe FolderID is a unique number used to identify a Folder.  
Public PropertyFolderNameThe name of the Folder  
Public PropertyHasErrorsThe HasErrors property can be used to determine if the object has any errors. If the object needs to be validated, it is done before returning. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyHomeDirectoryGets or sets the directory where jobs should begin execution.  
Public PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyLastChangeThe date and time that this Folder definition was last changed.  
Public PropertyLastChangedByUser who last changed this Folder.  
Public PropertyLastChangeUTCThe UTC date and time that this Folder definition was last changed.  
Public PropertyLoadedFromReturns the JAMS Server that this Folder was loaded from.  
Public PropertyLogLocationThis field specifies the location (device/directory) where batch log files should be placed.  
Public PropertyModifiedThe Modified property keeps track of modified state of this object. You cannot set the Modified property. If you modify the object, the modified property will be true until you end or cancel the update. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNameThe name of the Folder  
Public PropertyNewObjectThe NewObject property indicates that this object has just been created and has never been saved on a JAMS Server. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNotifyEMailGets or sets the list of Mail addresses, separated by commas. If a Job in this Folder requires notification, a mail message will be sent to this list of addresses.  
Public PropertyParametersGets the list of Parameters for this Folder.  
Public PropertyParentFolderGets or sets the JAMS Folder that this Folder is a member of.  
Public PropertyParentFolderIDGets the Parent Folder ID for this Folder. This property is designed to be used by JAMS, not user code.  
Public PropertyParentFolderNameGets or sets the fully qualified name of the JAMS Folder that this folder is a member of.  
Public PropertyPropertiesA collection of PropertyValues for this Folder  
Public PropertyQualifiedFolderName  
Public PropertyQualifiedNameReturn the fully-qualified name for this folder  
Public PropertyReferencesGets a list of References to this Folder.  
Public PropertyRetainOptionGets or sets the default retention policy for Jobs in this Folder. The options are:

Always (A) Jobs are always retained until specifically deleted.
Never (N) Never retain jobs.
Error (E) Jobs are retained if they complete with a severity of Warning or worse.
Timed (T) Jobs are retained for the specified time after completion.

 
Public PropertyRetainTimeGets or sets the length of time the job should be retained if the retain option is set to "Timed".  
Public PropertyRevisionHistoryGets a list of Folder versions.  
Public PropertySchedulingPriorityThis number is used to calculate the scheduling priority for Jobs in this Folder. When a Job is submitted by the JAMS, the scheduling priority is calculated by adding together the default scheduling priority, the Folder’s priority modifier and the Job’s priority modifier.  
Public PropertySearchPathGets or sets the Folder's Search Path.  
Public PropertyShortElapsedPercentThe Short Job Elapsed Time Percent specifies a minimum elapsed time for a job. If the job completes successfully in less than this amount of time it is considered a Short Job. This is specified as a percentage of the jobs average elapsed time. When a job is determined to be a short job, JAMS will perform notification for the job and may change the completion severity of the job.  
Public PropertyTagsThe Tags object manages the tags applied to this Folder.  
Public PropertyTemplateLibraryThe Template Library specifies the full file specification which contains the JAMS templates used when parsing a Job. Refer to Templates and Job Parsing for a complete description of template libraries.  
Public PropertyTimestampLogsWhen the field is true, batch log files be time stamped with an extension of .LOG_yyyymmdd_hhmmsscc.  
Public PropertyValidatedThe Validated property keeps track of the validation state of this object. If the object has been modified, Validated will be false until the object has been successfully validated by the Validate method. (Inherited from MVPSI.JAMS.BasePublicObject)
Top
See Also

Reference

Folder Class
MVPSI.JAMS Namespace

 

 

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.