Aqualogic Interaction API  
 

IPTJob Members

IPTJob overview

Public Instance Methods

AddJobListEntry Adds an operation to the list of items executed within this job
GetDeleteWhenDone Returns a boolean indicating whether the Job object will be automatically removed upon completion.
GetIsSuspendable - OBSELETE, Functionality moved to automation server agents - Returns a boolean indicating whether this operation supports suspension, or is capable of serializing its execution state.
GetSchedule Returns a schedule object indicating the next scheduled launch and recurring interval (if any)
GetSettingsAsInt Returns an int corresponding to a PT_JOB_SETTINGS determining runtimes, timeouts, and logging levels
GetSettingsAsXPDateTime Returns an XPDateTime corresponding to a PT_JOB_SETTINGS determining runtimes, timeouts, and logging levels
GetStatus - OBSELETE, Functionality moved to automation server agents - Returns an int corresponding to a PT_JOBSTATUS indicating the state of the job (running, interrupted, failed, suspended, etc.)
QueryJobList Returns the list of operations scheduled within this Job
RemoveJobListEntry Removes an existing operation from this Job's list
ResumeJob - OBSELETE, Functionality moved to automation server agents - Launches a previously suspended job.
SaveCheckpoint - OBSELETE, Functionality moved to automation server agents - A method used by the server to trigger suspension like action.
SetDeleteWhenDone Sets a boolean indicating whether the Job object will be automatically removed upon completion.
SetSettingsOverloaded. Sets an int corresponding to a PT_JOB_SETTINGS determining runtimes, timeouts, and logging levels
SetStatus - OBSELETE, Functionality moved to automation server agents - Sets an int corresponding to a PT_JOBSTATUS indicating the state of the job (running, interrupted, failed, suspended, etc.)
SuspendJob - OBSELETE, Functionality moved to agents - Forces running job to serialize its state at the next checkpoint. Suspended jobs can resume where they left off using the ResumeJob method.

See Also

IPTJob Interface | com.plumtree.server Namespace