| Name | Description | |
|---|---|---|
 | Folder Constructor | Creates a new Folder. |
The following tables list the members exposed by Folder.
Public Constructors
Public Properties
| Name | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
 | ACL | Access Control List | ||||||||
| BatchQueue | Gets the batch queue that Jobs within the Folder should be submitted to. | ||||||||
| BatchQueueName | Gets the name of the batch queue that Jobs within the Folder should be submitted to. | ||||||||
| Description | A description of this Folder. | ||||||||
| Elements | A collection of components which apply to jobs in this folder. | ||||||||
| Error | Gets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject) | ||||||||
| ExecuteAs | Gets the default Credentials for Jobs in this Folder. | ||||||||
| ExecuteAsID | Gets 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. | ||||||||
| ExecuteAsName | Gets the username of the default Credentials for Jobs in this Folder. | ||||||||
| FolderID | The FolderID is a unique number used to identify a Folder. | ||||||||
| FolderName | The name of the Folder | ||||||||
| HasErrors | The 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) | ||||||||
| HomeDirectory | Gets or sets the directory where jobs should begin execution. | ||||||||
| InEdit | Is this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject) | ||||||||
| Item | Returns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject) | ||||||||
| LastChange | The date and time that this Folder definition was last changed. | ||||||||
| LastChangedBy | User who last changed this Folder. | ||||||||
| LastChangeUTC | The UTC date and time that this Folder definition was last changed. | ||||||||
| LoadedFrom | Returns the JAMS Server that this Folder was loaded from. | ||||||||
| LogLocation | This field specifies the location (device/directory) where batch log files should be placed. | ||||||||
| Modified | The 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) | ||||||||
| Name | The name of the Folder | ||||||||
| NewObject | The NewObject property indicates that this object has just been created and has never been saved on a JAMS Server. (Inherited from MVPSI.JAMS.BasePublicObject) | ||||||||
| NotifyEMail | Gets 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. | ||||||||
| Parameters | Gets the list of Parameters for this Folder. | ||||||||
| ParentFolder | Gets or sets the JAMS Folder that this Folder is a member of. | ||||||||
| ParentFolderID | Gets the Parent Folder ID for this Folder. This property is designed to be used by JAMS, not user code. | ||||||||
| ParentFolderName | Gets or sets the fully qualified name of the JAMS Folder that this folder is a member of. | ||||||||
| Properties | A collection of PropertyValues for this Folder | ||||||||
| QualifiedFolderName | |||||||||
| QualifiedName | Return the fully-qualified name for this folder | ||||||||
| References | Gets a list of References to this Folder. | ||||||||
| RetainOption | Gets or sets the default retention policy for Jobs in this Folder. The options are:
| ||||||||
| RetainTime | Gets or sets the length of time the job should be retained if the retain option is set to "Timed". | ||||||||
| RevisionHistory | Gets a list of Folder versions. | ||||||||
| SchedulingPriority | This 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. | ||||||||
| SearchPath | Gets or sets the Folder's Search Path. | ||||||||
| ShortElapsedPercent | The 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. | ||||||||
| Tags | The Tags object manages the tags applied to this Folder. | ||||||||
| TemplateLibrary | The 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. | ||||||||
| TimestampLogs | When the field is true, batch log files be time stamped with an extension of .LOG_yyyymmdd_hhmmsscc. | ||||||||
| Validated | The 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) |
Public Methods
| Name | Description | |
|---|---|---|
 | BeginEdit | Starts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject) |
| CancelEdit | Cancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject) |
 | Check | Check to see if a Folder is valid and the caller has the access desired. |
| ClearError | Clears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject) |
| ClearModified | Overridden. Clear the modified flag of this Folder and all of the attached lists. |
| Clone | Implementation of ICloneable Clone. |
| CompareTo | Implementation of IComparable CompareTo. Compares this instance to the one specified. |
| CopyTo | Copy the Folder with a new name and/or server |
| Delete | Overloaded. Delete the Folder definition. |
| EndEdit | Ends an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject) |
| Equals | Checks for equality. |
| Exists | Overloaded. Test to determine if a given Folder exists on the default server. |
| Find | Overloaded. Returns a Collection of Folders contained in the specified folder. |
| GetAccessControl | Overloaded. Gets a FolderSecurity object that encapsulates the access control list (ACL) entries for the Folder described by the current Folder object. |
| GetChildNames | Gets a list of Child Names of the Folder |
| GetDocumentation | Gets All Documentation based on inherited folders and job definition. |
| GetFolderDescendants | Returns a collection of descendant FolderIDs |
| GetHashCode | Returns a hashcode. |
| Initialize | Initializes a Folder to default values. |
| Load | Overloaded. Load the Folder with the specified name from the specified JAMS Server. |
| MoveTo | Save the Folder with a new name and/or server and remove the old instance of the folder. |
| PathExists | Test to determine whether ANY type of folder object (or folder) exists at the given path on the specified server. |
| ReadXml | Reads Folder values from XML |
| ResetStatistics | Resets the Statistics of Jobs and Setup's within a Folder. |
| ResetTriggers | Resets triggers on the folder that match the passed name. If the name is null or empty, all of the folder's triggers are reset. |
| SaveAs | Save the Folder with a new name and/or server. |
| SetAccessControl | Applies access control list (ACL) entries described by a FolderSecurity object to the Folder described by the current Folder object. |
| SetError | Sets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject) |
| SetModified | Marks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject) |
| ToString | Convert a Folder to a String |
| UndoEdits | Undo changes. (Inherited from MVPSI.JAMS.BasePublicObject) |
| Update | Overloaded. Overridden. Save pending updates. |
| Validate | Overloaded. Overridden. Validate all properties. |
| WriteXml | Write the Folder definition as XML |
Protected Methods
| Name | Description | |
|---|---|---|
 | RaisePropertyChanged | Attempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject) |
| RaisePropertyChanging | Attempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject) |
| SaveOriginal | SaveOriginal is called when an edit is about to begin. You override this method to save the original values. (Inherited from MVPSI.JAMS.BasePublicObject) |
Public Events
| Name | Description | |
|---|---|---|
 | PropertyChanged | Event Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject) |
| PropertyChanging | Event Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject) |
See Also