The following tables list the members exposed by Folder.
Public Constructors
| Name | Description | |
|---|---|---|
 | Folder Constructor | Creates a new Folder. |
Public Properties
| Name | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
 | ACL | Access Control List | ||||||||
| Alerts | Gets the list of Alerts for this Folder. | ||||||||
| AlertsModified | Gets a boolean which indicates if the Alerts were modified after the Alert was Loaded. | ||||||||
| BatchQueue | Gets or sets the JAMS Batch Queue that Jobs within the Folder should be submitted to. | ||||||||
| BatchQueueID | Gets and Sets the ID of the Batch Queue. | ||||||||
| BatchQueueName | Gets or sets the batch queue that Jobs within the Folder should be submitted to. | ||||||||
| Description | A description of this Folder. | ||||||||
| Error | Gets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject) | ||||||||
| 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 | This field specifies 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) | ||||||||
| KeepLogs | When the field is true, batch log files will not be deleted at the completion of the Job. | ||||||||
| 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 | This is a 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. | ||||||||
| NotifyJob | A JAMS Job which should be submitted when notification is required. | ||||||||
| NotifyJobID | Gets and Sets the ID of the notification job. This property is designed to be used by JAMS, not user code. | ||||||||
| NotifyJobName | Gets and Sets the name of the notification job. | ||||||||
| NotifyJobNameIsRelative | Gets or Sets the "Notify Job Name Is Relative" property. If set to true, it means NotifyJobName is a relative path. Otherwise, NotifyJobName is an absolute path. | ||||||||
| NotifyOther | NotifyOther is used to an additional notification method. For OpenVMS based JAMS servers, this is a list of operator classes, separated by commas. If a Job in this Folder requires notification, a message will be sent to these operator classes. | ||||||||
| NotifyUsers | This is a list of usernames, separated by commas. If a Job in this Folder requires notification, a message will be broadcast to these users (if they are logged on at the time.) | ||||||||
| Parameters | Gets the list of Parameters for this Folder. | ||||||||
| ParamsModified | Gets a boolean which indicates if the Parameters were modified after the Method was Loaded. | ||||||||
| 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 name of the JAMS Folder that this folder is a member of. | ||||||||
| PrintLocation | This field specifies the directory where print files should be placed. | ||||||||
| PrintQueue | Specifies the default print queue for Reports in this Folder. Report definitions are part of a Job’s definition. This queue can be overridden in the Report definition. | ||||||||
| QualifiedName | Return the fully-qualified name for this folder | ||||||||
| RecoveryInstructions | Recovery instructions to be included in notification e-mail messages. | ||||||||
| Requirements | Resource Requirements for this Folder. | ||||||||
| RequirementsModified | Returns true if the Requirements were modified during an edit. | ||||||||
| RetainOption | Specifies the default retention policy for Jobs in this Folder. The options are:
| ||||||||
| RetainTime | Length of time the job should be retained if the retain option is set to "Timed". | ||||||||
| RevisionHistory | Gets a list of Folder versions. | ||||||||
| RunawayElapsedPer | The Runaway Job Elapsed Time Percent specifies how long a job may run before it is considered a runaway job. This is specified as a percentage of the jobs average elapsed time. When the job is considered runaway, JAMS will perform notification for the job. | ||||||||
| SchedulingPriorityModifier | 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 | The Folder's Search Path | ||||||||
| ShortElapsedPer | 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. | ||||||||
| ShortSeverity | If specified, when a job is determined to be a Short Job, the completion severity will be changed to the severity specified here. | ||||||||
| StalledTime | Specifies how much time may elapse after a jobs scheduled time before the job is considered to be stalled. When the job is considered stalled, JAMS will perform notification for the job. | ||||||||
| 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. | ||||||||
| UserID | Gets and Sets the UserID for jobs in this Folder. This property is designed to be used by JAMS, not user code. | ||||||||
| UserName | The default username for Jobs in this Folder. | ||||||||
| UserSecurity | JAMS UserSecurity. | ||||||||
| 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. |
| ForceModified | Forces the Folder and all of the Folder's sub-objects to be marked as modfied. |
| 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 |
| GetFolderDescendants | Returns a collection of descendant FolderIDs |
| GetHashCode | Returns a hashcode. |
| GetNumberOfChildren | Fetch the number of children for this folder |
| Initialize | Initializes a Folder to default values. |
| IsAncestorOf | Determines if a folder is an ancestor of another folder |
| 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. |
| ResetStatistics | Resets the Statistics of Jobs and Setup's within a Folder. |
| 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 | Overridden. Undo changes that have not been saved to the database. |
| Update | Overloaded. Save the Folder definition on the specified JAMS Server. |
| Validate | Overloaded. Overridden. Validate all properties. |
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