WebCenter Interaction API  
 

IPTJob Members

IPTJob overview

Public Instance Methods

public methodAddJobListEntry Adds an operation to the list of items executed within this job
public methodGetDeleteWhenDone Returns a boolean indicating whether the Job object will be automatically removed upon completion.
public methodGetIsSuspendable - OBSELETE, Functionality moved to automation server agents - Returns a boolean indicating whether this operation supports suspension, or is capable of serializing its execution state.
public methodGetLastStatus Returns an int corresponding to a PT_JOBSTATUS indicating the state of the job when it was run or is running last time. Status can be running, interrupted, failed, suspended, etc.
public methodGetSchedule Returns a schedule object indicating the next scheduled launch and recurring interval (if any)
public methodGetSettingsAsInt Returns an int corresponding to a PT_JOB_SETTINGS determining runtimes, timeouts, and logging levels
public methodGetSettingsAsXPDateTime Returns an XPDateTime corresponding to a PT_JOB_SETTINGS determining runtimes, timeouts, and logging levels
public methodGetStatus - 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.)
public methodQueryJobList Returns the list of operations scheduled within this Job
public methodRemoveJobListEntry Removes an existing operation from this Job's list
public methodResumeJob - OBSELETE, Functionality moved to automation server agents - Launches a previously suspended job.
public methodSaveCheckpoint - OBSELETE, Functionality moved to automation server agents - A method used by the server to trigger suspension like action.
public methodSetDeleteWhenDone Sets a boolean indicating whether the Job object will be automatically removed upon completion.
public methodSetSettingsOverloaded. Sets an int corresponding to a PT_JOB_SETTINGS determining runtimes, timeouts, and logging levels
public methodSetStatus - 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.)
public methodSuspendJob - 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