JAMS 6.x Help
CurJob Class Members
Properties  Methods  Events


The following tables list the members exposed by CurJob.

Public Constructors
 NameDescription
Public ConstructorCurJob ConstructorCreates a CurJob.  
Top
Public Properties
 NameDescription
Public PropertyAgentTrue if this Job is running on a remote system which has a JAMS Agent.  
Public PropertyAgentNodeGets the node the Job is to run on.  
Public PropertyAltUserNameAn alternate username that the execution method may require.  
Public PropertyAuditTrailGets a list of audit trail events for this entry.  
Public PropertyBatchQueueGets the batch queue used by this run.  
Public PropertyBatchQueueIDGets and Sets the BatchQueueID for this CurJob. This property is designed to be used by JAMS, not user code.  
Public PropertyBatchQueueNameThe name of this CurJob's BatchQueue.  
Public PropertyCompletionTimeGets the date and time that this Job completed.  
Public PropertyCompletionTimeUTCGets the UTC date and time that this Job completed.  
Public PropertyCurrentStateGets or Sets this CurJob's state.  
Public PropertyCurrentStepGets the CurrentStep property. For multi-job Setups this indicates which step is currently executing.  
Public PropertyDebugModeGets the debug mode for this run. True if this was a debug run. Debug runs don't satisfy dependencies or fire triggers.  
Public PropertyDependOKGets a boolean which indicates if the dependencies defined for this Job have been satisfied.  
Public PropertyDescriptionGets a description of the entry.  
Public PropertyDetailIDGets the Setup's DetailID which defines an instance of a Job.  
Public PropertyDisplayNameGets the display name of the Job  
Public PropertyElapsedTimeGets the jobs current elapsed execution time. If the job has completed, the time is the total execution time of the job.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyFinalSeverityGets the final severity for this run.  
Public PropertyFinalStatusGets the final status for this run.  
Public PropertyFinalStatusCodeGets the final status for this run.  
Public PropertyHaltedTrue when a multi-job Setup is halted.  
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 PropertyHeldGets the Held property. Returns true if this entry is currently Held.  
Public PropertyHoldTimeGets the HoldTime property. This entry will be released to run at this time.  
Public PropertyHoldTimeUTCGets the HoldTime property. This entry will be released to run at this UTC time.  
Public PropertyIconGets the type of event that initiated this entry.  
Public PropertyIgnoreResReqGets the IgnoreResReq property. Returns true if the Job should ignore its resource requirments.  
Public PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyInitiatorIDGets an identifier of an object that initiated this entry. For an InitiatorType of Trigger, this is the TriggerID. For an InitiatorType of Notify, Recover, Precheck and RepeatSubmit, this is a JAMS Entry.  
Public PropertyInitiatorTypeGets the type of event that initiated this entry.  
Public PropertyInitiatorTypeValueThe integer value of the InitiatorType. This is required to support different versions on client and server  
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyJAMSEntryGets the JAMS entry number for this CurJob.  
Public PropertyJAMSIdGets the JAMS Id for this CurJob.  
Public PropertyJobGets the complete Job definition.  
Public PropertyJobIDGets the Job ID.  
Public PropertyJobNameGets the name of the Job  
Public PropertyJobStatusGets the JobStatus text.  
Public PropertyKeepLogsGets the KeepLogs property. When set to true, the Job's log file is kept upon completion.  
Public PropertyLoadedFromGets the JAMS Server that this run is from.  
Public PropertyLogFileGets a Stream which contains the LogFile for this CurJob.  
Public PropertyLogFileActiveGets the boolean property which indicates if this Log filename is active for this CurJob.  
Public PropertyLogFilenameGets the Log filename for this CurJob.  
Public PropertyMasterEntryGets the MasterEntry property. If this was a member of a multi-job Setup this number identifies the parent Setup's JAMSEntry.  
Public PropertyMasterRONGets the master run occurance Number. If this was a member of a multi-job Setup this number identifies the parent Setup.  
Public PropertyMessageA message explaining the state change.  
Public PropertyMissedWindowActionGets what actions should occur if this job misses it's scheduled window.  
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 PropertyMonitorGets the Monitor property. Returns true if this entry is viewable in the JAMS Monitor.  
Public PropertyNameReturns a name for the job, the DisplayName if there is one. Otherwise, the JobName.  
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 PropertyNodeNameGets the node that ran this job.  
Public PropertyNoteGets the note added to this run when it was submitted.  
Public PropertyNotifyOfMissedWindowGets the NotifyOfMissedWindow property. When set to true, notification will be performed if this job misses it's schedule window.  
Public PropertyNotifyUserGets the NotifyUser property. If set to true, the user who manually submits the job will be added to the notification list.  
Public PropertyOriginalHoldTimeGets the Original HoldTime property. This is the value of the HoldTime property when this Job was originally placed into the schedule.  
Public PropertyOriginalHoldTimeUTCGets the Original HoldTime property. This is the value of the HoldTime property when this Job was originally placed into the schedule UTC time.  
Public PropertyParametersGets the list of Parameters for this CurJob.  
Public PropertyParentFolderIDGets the Job's parent folder ID.  
Public PropertyPermanentWhen true, the overriden Icon will persist through the entry's lifecycle.  
Public PropertyPrecheckCountGets the PrecheckCount property. If the Job or Setup definition allows the precheck Job to run on an interval this value indicates how many times the precheck Job has been released to run.  
Public PropertyPrecheckEntryGets the PrecheckEntry property. If a precheck Job is specified for this Job this value specifies the JAMSEntry number for that precheck Job.  
Public PropertyPrecheckIntervalGets the interval between runs of the Job's Precheck job.  
Public PropertyPrecheckJobGets the JAMS Job that will serve as a Precheck Job for this Job.  
Public PropertyPrecheckJobIDGets the ID of the precheck job. This property is designed to be used by JAMS, not user code.  
Public PropertyPrecheckTimeGets the PrecheckTime property. This value indicates the next DateTime that this precheck Job will be released.  
Public PropertyPrecheckTimeUTCGets the PrecheckTime property. This value indicates the next UTC DateTime that this precheck Job will be released.  
Public PropertyPreprocessedGets the Preprocessed property. Returns true if this entry has been preprocessed. Jobs which are preprocessed have had their parameters evaluated and Job source created from the Job definition.  
Public PropertyProcessIDGets the operating system's process identifier for this run.  
Public PropertyProxyTrue if the process which is running this Job is a proxy. A proxy process runs a Job on a system not monitored by a JAMS Agent. In this case the statistics associated with the proxy process do not represent those of the real Job.  
Public PropertyQueueEntryGets the queue entry. This is for reference only and is used to link a JAMS entry to an O/S specific batch queue entry.  
Public PropertyReportsGets the list of Reports for this CurJob.  
Public PropertyRestartableGets the restartablity of this job. A restartable job can be aborted and restarted.  
Public PropertyRestartCountGets the RestartCount property. If this Job has been restarted the value here indicates how many restarts have occured.  
Public PropertyRetainOptionGets the retention policy for this Job. The options are:

Not Specified The retention policy is taken from the Job's System 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 the length of time the Job should be retained when the retain option is set to "Timed".  
Public PropertyRONGets the run occurance number.  
Public PropertyRunawayGets this job's runaway state. This will be true if the job has exceeded one of it's execution time limits.  
Public PropertyRunawayElapsedGets the absolute runaway elapsed time. If the job runs longer than this it is declared a runaway job and notification will be performed.  
Public PropertyRunPriorityGets the execution priority for this job.  
Public PropertyScheduledTimeGets the date and time that this Job was submitted to the JAMS schedule.  
Public PropertyScheduledTimeUTCGets the UTC date and time that this Job was submitted to the JAMS schedule.  
Public PropertyScheduleFromTimeGets the beginning of this job's scheduled time window.  
Public PropertyScheduleToTimeGets the ending of this job's schedule time window.  
Public PropertyScheduleWindowGets the Job's Scheduled Window using a JAMS Time definition.  
Public PropertyScheduleWindowIDGets the the Schedule Window ID for this Job. This property is designed to be used by JAMS, not user code.  
Public PropertySchedulingPriorityGets the SchedulingPriority property.  
Public PropertySetupGets the complete Setup definition.  
Public PropertySetupIDGets the Setup ID.  
Public PropertySetupOkTrue if this Job completed successfully. In a multi-job Setup if any one Job sets this property to false then the Setup will fail.  
Public PropertySourceA snapshot of the Job's source for this instance of the Job.  
Public PropertyStalledGets this job's stalled state. This will be true if the job has been pending longer than it's stalled time limit.  
Public PropertyStalledTimeGets how much time may elapse after a job's scheduled time before the job is considered to be stalled. When the job is considered stalled, JAMS will perform notification for the job.  
Public PropertyStartTimeGets the date and time that this Job actually started.  
Public PropertyStartTimeUTCGets the UTC date and time that this Job actually started.  
Public PropertyStepGets the Step property. Each Job in a multi-job Setup can have a Step value. If specified, Jobs run in Step order.  
Public PropertyStepWaitGets a boolean which indicates if this Job is waiting for previous steps to complete.  
Public PropertySubmitMethodGets the JAMS Submit Method for this Job.  
Public PropertySubmitMethodIDGets the the Submit Method ID for this Job. This property is designed to be used by JAMS, not user code.  
Public PropertySubmittedByGets the identity of the user who submitted this run.  
Public PropertySuppressNotifyGets the SuppressNotify property. If set to true Job completion notification is suppressed.  
Public PropertyTempFilenameGets the full path to this CurJob's temp file.  
Public PropertyTodaysDateGets the TodaysDate property. This is used as an anchor to translate english-language date specifications into DateTime values.  
Public PropertyUserIDGets and Sets the UserID for this CurJob. This property is designed to be used by JAMS, not user code.  
Public PropertyUserNameThe username this job should execute under.  
Public PropertyUserSecurityJAMS UserSecurity.  
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 PropertyVersionGets the Record Version.  
Public PropertyWaitForGets this jobs WaitFor property. This is true in the Setup that contains this job should wait for the completion of this job before advancing it's step.  
Public PropertyWFTrackingGets a list of workflow tracking records for this entry  
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 MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedClearModified is designed to be used internally and should not be called from end-user code. Call Update() which saves the modifications and then calls ClearModified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCompareToImplementation of IComparable. Compares two CurJob objects.  
Public MethodDeleteOverloaded. Abort or delete this entry.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public Methodstatic (Shared in Visual Basic)FindOverloaded. Creates and loads a CurJobList collection.  
Public MethodHoldOverloaded. Holds this entry until released.  
Public MethodInitializeInitializes all properties to their default values.  
Public Methodstatic (Shared in Visual Basic)LoadLoad a CurJob from the specified JAMS Server.  
Public MethodReleaseOverloaded. Releases this entry from one or more of it's scheduling requirements.  
Public Methodstatic (Shared in Visual Basic)ReprocessCompletionReprocesses the completion of the specified entry.  
Public MethodRescheduleOverloaded. Reschedules the entry. Sends changes that you have made to the CurJob object to the JAMS Schedule engine. The only properties that can be changed are: AgentNode BatchQueue HoldTime Held SchedulingPriority  
Public MethodRestartOverloaded. Restarts an executing entry.  
Public Methodstatic (Shared in Visual Basic)RestoreDataOverloaded. Restores a serialized object from the database.  
Public MethodSaveDataOverloaded. Saves a serialized object to the database for this entry.  
Public MethodSendDataOverloaded. Sends data to the job. The exact results produced by calling SendData are defined by the execution method. For example, calling SendData for a Workflow will resume the a bookmark named dataName, passing it the dataValue.  
Public MethodSetEntryStateOverloaded. Sets the JobStatus, Icon, and Message of the current entry as well as if the Icon change is permanent.  
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 MethodSetStatusOverloaded. Sets the current status of the job. This status is displayed in the monitor view.  
Public MethodToStringString representation of a Job currently in the schedule.  
Public MethodUndoEditsOverridden. Throws a NotSupportedException, you cannot edit a CurJob.  
Public MethodUpdateOverridden. Throws a NotSupportedException, you cannot edit a CurJob.  
Public MethodValidateThe Validate method is a virtual method used to validate the object. The default implantation does no validation it simply marks the object as valid. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodWriteSourceUpdate the source of this entry.  
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

CurJob Class
MVPSI.JAMS Namespace

Send Feedback