JAMS Developer Guide
Job Class Members
Properties  Methods  Events


MVPSI.JAMS Namespace : Job Class

The following tables list the members exposed by Job.

Public Constructors
 NameDescription
Public ConstructorJob ConstructorCreates a new Job.  
Top
Public Properties
 NameDescription
Public PropertyACLAccess Control List  
Public PropertyAgentNameGets or sets the Agent for this Job. If this job is run on a remote node, this specifies the name of that node.  
Public PropertyAvgBufferedIOCountGets the average buffered I/O count for this job.  
Public PropertyAvgCountGets the number of times that the Job's averages have been updated.  
Public PropertyAvgCpuTimeGets the average Cpu time consumed by this job.  
Public PropertyAvgDirectIOCountGets the average direct I/O count for this job.  
Public PropertyAvgElapsedTimeGets the average elapsed time for this job.  
Public PropertyAvgPageFaultsGets the average number of page faults incurred by this job.  
Public PropertyAvgWorkingSetPeakGets the average peak working set for this job.  
Public PropertyBatchQueueGets or sets the JAMS Batch Queue that the Job should be submitted to.  
Public PropertyBatchQueueIDGets and Sets the BatchQueueID that the Job should be submitted to. This property is designed to be used by JAMS, not user code.  
Public PropertyBatchQueueNameGets or sets the batch queue that this job should be submitted to. This overides the default batch queue that is specified in the job's folder definition.  
Public PropertyDefaultDateGets or sets the default submit date to use when this job is manually submitted.  
Public PropertyDefaultSubmitTimeGets or sets the default submit time to use when this job is manually submitted.  
Public PropertyDescriptionGets or sets the description of this Job.  
Public PropertyElementsA collection of elements that apply to this Job  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyExecuteAsJAMS Credential.  
Public PropertyExecuteAsNameGets or sets the username that this Job should run under. This overrides the username specified in the Job's Folder definition.  
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 home directory for this Job.  
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 PropertyJobIDGets an integer that uniquely identifies this Job definition.  
Public PropertyJobNameGets or sets the name of the Job  
Public PropertyKeepLogsGets or sets the KeepLogs property. When set to true, the Job's log file is kept upon completion. If specified, this overrides the default in the Job's Folder definition.  
Public PropertyLanguageGets the scripting language used by this Job.  
Public PropertyLastAutosubmitGets the scheduled date and time that this Job was last automatically submitted for. This is a read-only property, it is updated when JAMS automatically submits the Job.  
Public PropertyLastAutosubmitUTCGets the scheduled UTC date and time that this Job was last automatically submitted for. This is a read-only property, it is updated when JAMS automatically submits the Job.  
Public PropertyLastChangeGets the date and time when this Job definition was last changed.  
Public PropertyLastChangedByGets the user who last changed this Job.  
Public PropertyLastChangeUTCGets the UTC date and time when this Job definition was last changed.  
Public PropertyLastErrorGets the date and time of the most recent error completion of this Job.  
Public PropertyLastErrorUTCGets the UTC date and time of the most recent error completion of this Job.  
Public PropertyLastFatalGets the date and time of the most recent fatal completion of this Job.  
Public PropertyLastFatalUTCGets the UTC date and time of the most recent fatal completion of this Job.  
Public PropertyLastInfoGets the date and time of the most recent informational completion of this Job.  
Public PropertyLastInfoUTCGets the UTC date and time of the most recent informational completion of this Job.  
Public PropertyLastResetGets the most recent reset date and time. When a job is reset, all of it's dependencies are reset and they must run again.  
Public PropertyLastResetUTCGets the most recent reset UTC date and time. When a job is reset, all of it's dependencies are reset and they must run again.  
Public PropertyLastSuccessGets the date and time of the most recent successful completion of this Job.  
Public PropertyLastSuccessUTCGets the UTC date and time of the most recent successful completion of this Job.  
Public PropertyLastWarningGets the date and time of the most recent warning completion of this Job.  
Public PropertyLastWarningUTCGets the UTC date and time of the most recent warning completion of this Job.  
Public PropertyLoadedFromGets the JAMS Server that this Job was loaded from.  
Public PropertyLogFilenameGets or sets the file specification that should be used for this job's log files. The default is the job name with an extention of .LOG.  
Public PropertyMaxBufferedIOCountGets the maximum buffered I/O count for this job.  
Public PropertyMaxCountGets the number of times that one or more of the job's maximums has been updated.  
Public PropertyMaxCpuTimeGets the maximum Cpu time consumed by this job.  
Public PropertyMaxDirectIOCountGets the the maximum direct I/O count for this job.  
Public PropertyMaxElapsedTimeGets the maximum elapsed time for this job.  
Public PropertyMaxPageFaultsGets the maximum number of page faults incurred by this job.  
Public PropertyMaxWorkingSetPeakGets the maximum peak working set for this job.  
Public PropertyMethodGets or Sets the JAMS Submit Method for this Job.  
Public PropertyMethodIDGets and Sets the Submi tMethod ID for this Job. This property is designed to be used by JAMS, not user code.  
Public PropertyMethodNameGets the Submit Method Name for this Job.  
Public PropertyMinBufferedIOCountGets the minimum buffered I/O count for this job.  
Public PropertyMinCountGets the number of times that one or more of the job's minimums has been updated.  
Public PropertyMinCpuTimeGets the minimum Cpu time consumed by this job.  
Public PropertyMinDirectIOCountGets the minimum direct I/O count for this job.  
Public PropertyMinElapsedTimeGets the minimum elapsed time for this job.  
Public PropertyMinPageFaultsGets the minimum number of page faults incurred by this job.  
Public PropertyMinWorkingSetPeakGets the minimum peak working set for this job.  
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 PropertyNameGets or sets the name of the Job  
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 e-mail addresses, separated by commas. If this Job requires notification, a mail message will be sent to this list of addresses.  
Public PropertyParametersGets the list of Parameters for this Job.  
Public PropertyParentFolderGets or sets the JAMS Folder that this Job is a member of.  
Public PropertyParentFolderIDGets the Folder ID for this Job. 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 job is a member of.  
Public PropertyPropertiesA collection of PropertyValues for this Job  
Public PropertyQualifiedFolderNameGets the fully qualified name of the folder that contains this job.  
Public PropertyQualifiedNameReturn the full qualified name of the job  
Public PropertyReferencesGets a list of References to this Job.  
Public PropertyRetainOptionGets or sets the retention policy for this Job. The options are:

Not Specified The retention policy is taken from the Job's Folder definition.
Always (A) Job is always retained until specifically deleted.
Never (N) Never retain job.
Error (E) Job is retained if it completes with a severity of Warning or worse.
Timed (T) Job is retained for the specified time after completion.

 
Public PropertyRetainTimeGets or sets the length of time the Job should be retained when the retain option is set to "Timed".  
Public PropertyRetryCountGets or sets the number of times to retry the job if it fails.  
Public PropertyRetryIntervalGets or sets the delay between automatic retries  
Public PropertyRevisionHistoryGets a list of Job version.  
Public PropertyRunPriorityGets or sets the execution priority for this job.  
Public PropertySchedulingPriorityGets or sets the SchedulingPriority property. This number is used to calculate the scheduling priority for this Job. When a Job is submitted by the JAMS submit sub-system, the scheduling priority is calculated by adding together the default scheduling priority, the Folder’s priority modifier and the Job’s priority modifier.  
Public PropertySLATimeThe time of day that a job must be completed by to meet a Service Level Agreement  
Public PropertySourceGets or sets the command procedure.  
Public PropertySourceElementsA collection of elements that make up the source code for this job  
Public PropertySourceModifiedGets a boolean which indicates if the Source was modified after the Job was Loaded.  
Public PropertySpecificInformationalA comma seperated list of specific informational values. Used when the executions method's ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad. Matching one of these values will result in a final severity of Informational.  
Public PropertySpecificValuesA comma seperated list of specific values. Used when the execution method's ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad.  
Public PropertySpecificWarningA comma seperated list of specific warning values. Used when the execution method's ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad. Matching one of these values will result in a final severity of Warning.  
Public PropertySubmitOnHoldGets or sets the SubmitOnHold property. When submitted, should this job be placed on hold until manually released?  
Public PropertySuppressMenuDisplayGets or sets the SuppressMenuDisplay property. You can prevent this job from being displayed on submit menus by setting this property to true.  
Public PropertyTagsThe Tags object manages the tags applied to this Job.  
Public PropertyTimestampLogsGets or sets the TimestampLogs property. When 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)
Public PropertyWorkingSetDefaultGets or sets the default working set for this job. Not currently used.  
Public PropertyWorkingSetMaxGets or sets the maximum working set for this job. Not currently used.  
Public PropertyWorkingSetQuotaGets or sets the working set quota for this job. Not currently used.  
Top
Public Methods
 NameDescription
Public MethodBeginEditStarts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCancelEditCancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodChangeMethodUpdates the Job after its submit method has been changed. Properties and parameters of the old submit method are replaced by properties of the new submit method with any common values being retained.  
Public Methodstatic (Shared in Visual Basic)CheckChecks a Job against a JAMS Server.  
Public MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedOverridden. Clear the modified flag of this Job and all of the attached lists.  
Public MethodCloneClone this Job. Clone always assumes that the new object might be saved on a different JAMS Server so it doesn't copy internal things like IDs.  
Public MethodCompareToImplementation of IComparable CompareTo. Compares this instance to the one specified.  
Public MethodDeleteOverloaded. Delete the Job definition.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodEqualsChecks for equality.  
Public Methodstatic (Shared in Visual Basic)ExistsOverloaded. Test to determine if a given Job exists on the default server.  
Public Methodstatic (Shared in Visual Basic)FindOverloaded. Returns a collection of jobs matching the given search string.  
Public MethodForceModifiedForces the job and all of the jobs's sub-objects to be marked as modified.  
Public MethodGetAccessControlOverloaded. Gets a JobSecurity object that encapsulates the access control list (ACL) entries for the Job described by the current Job object.  
Public MethodGetDocumentationGets All Documentation based on inherited folders and job definition.  
Public MethodGetHashCodeReturns a hashcode.  
Public MethodInitializeInitializes all properties to their default values.  
Public Methodstatic (Shared in Visual Basic)LoadOverloaded. Load a Job definition from the specified JAMS Server.  
Public MethodMoveToMove the job to a different folder, removing it from the old location.  
Public MethodReadXmlReads Job values from XML  
Public MethodResetStatisticsResets the Job's Statistics  
Public MethodResetTriggersResets triggers on the job that match the passed name. If the name is null or empty, all of the job's triggers are reset.  
Public MethodSaveAsSave the Job with a new name and/or server.  
Public MethodSetAccessControlApplies access control list (ACL) entries described by a JobSecurity object to the Job described by the current Job object.  
Public MethodSetErrorSets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodSetModifiedMarks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodToStringReturns the string equivalent of this Job.  
Public MethodUndoEditsUndo changes. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodUpdateOverloaded. Save updates to the JAMS Server  
Public MethodValidateOverloaded. Overridden. Validate all properties.  
Public MethodWriteXmlReads Job values from XML  
Top
Protected Methods
 NameDescription
Protected MethodRaisePropertyChangedAttempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodRaisePropertyChangingAttempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodSaveOriginalSaveOriginal is called when an edit is about to begin. You override this method to save the original values. (Inherited from MVPSI.JAMS.BasePublicObject)
Top
Public Events
 NameDescription
Public EventPropertyChangedEvent Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject)
Public EventPropertyChangingEvent Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject)
Top
See Also

Reference

Job Class
MVPSI.JAMS Namespace

 

 

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