Package com.redwood.scheduler.api.model

Interface ProcessMonitorItem

All Superinterfaces:

Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface ProcessMonitorItem
extends NamedDetailObject, Readable

An item in the Process Monitor.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ProcessMonitorItem" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<ProcessMonitorItem>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
void	finish()	Finish the ProcessMonitorItem.
Long	getDisplayIndex()	Get the value for DisplayIndex.
Long	getDisplayOrder()	Get the value for DisplayOrder.
Long	getDisplayPercentage()	Get the value for DisplayPercentage.
Long	getDisplayTotal()	Get the value for DisplayTotal.
Long	getParentOffset()	Get the value for ParentOffset.
ProcessMonitor	getProcessMonitor()	Get the ProcessMonitor.
String	getProgress()	Get the value for Progress.
DateTimeZone	getProgressEnd()	Get the value for ProgressEnd.
Long	getProgressNumber()	Get the value for ProgressNumber.
Long	getProgressNumberMax()	Get the value for ProgressNumberMax.
Long	getProgressPercentComplete()	Get the value for ProgressPercentComplete.
DateTimeZone	getProgressStart()	Get the value for ProgressStart.
JobStatus	getProgressStatus()	Get the value for ProgressStatus.
String	getProgressText()	Get the value for ProgressText.
SchedulerEntity	getRelatedObject()	Get the value for RelatedObject.
ObjectDefinition	getRelatedObjectDefinition()	Get the RelatedObjectDefinition.
Long	getStartCount()	Get the value for StartCount.
ProcessMonitorItemStatus	getStatus()	Get the value for Status.
DateTimeZone	getStatusChanged()	Get the value for StatusChanged.
ProcessMonitorItemType	getType()	Get the value for Type.
void	incrementStartCount()	Increments the start count.
void	setCalculatedStatus()	Sets the Status to the value calculated from the relative object.
void	setDisplayOrder(Long newDisplayOrder)	Set the value for DisplayOrder.
void	setProgressEnd(DateTimeZone newProgressEnd)	Set the value for ProgressEnd.
void	setProgressNumber(Long newProgressNumber)	Set the value for ProgressNumber.
void	setProgressNumberMax(Long newProgressNumberMax)	Set the value for ProgressNumberMax.
void	setProgressPercentComplete(Long newProgressPercentComplete)	Set the value for ProgressPercentComplete.
void	setProgressStart(DateTimeZone newProgressStart)	Set the value for ProgressStart.
void	setProgressStatus(JobStatus newProgressStatus)	Set the value for ProgressStatus.
void	setProgressText(String newProgressText)	Set the value for ProgressText.
void	setRelatedObject(SchedulerEntity newRelatedObject)	Set the value for RelatedObject.
void	setRelatedObjectDefinition(ObjectDefinition newRelatedObjectDefinition)	Set the value for RelatedObjectDefinition.
void	setType(ProcessMonitorItemType newType)	Set the value for Type.
void	start()	Start the ProcessMonitorItem.

Methods inherited from interface com.redwood.scheduler.api.model.NamedDetailObject

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "ProcessMonitorItem" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<ProcessMonitorItem> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getDisplayOrder

Long getDisplayOrder()

Get the value for DisplayOrder. (The display order of the item) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getType

ProcessMonitorItemType getType()

Get the value for Type. (The type of the Item) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getRelatedObject

SchedulerEntity getRelatedObject()

Get the value for RelatedObject. (The SchedulerEntity that is related to this item, or null if no related item, or it has been deleted)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getStartCount

Long getStartCount()

Get the value for StartCount. (The number of times this task has been started.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgressText

String getProgressText()

Get the value for ProgressText. (The progress text of the ProcessMonitor)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgressPercentComplete

Long getProgressPercentComplete()

Get the value for ProgressPercentComplete. (The percentage completed of the ProcessMonitor)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgressNumber

Long getProgressNumber()

Get the value for ProgressNumber. (The progress as a number)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgressNumberMax

Long getProgressNumberMax()

Get the value for ProgressNumberMax. (The progress number maximum)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgressStatus

JobStatus getProgressStatus()

Get the value for ProgressStatus. (The final status the item)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgressStart

DateTimeZone getProgressStart()

Get the value for ProgressStart. (The start time of the item)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgressEnd

DateTimeZone getProgressEnd()

Get the value for ProgressEnd. (The start time of the item)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProgress

String getProgress()

Get the value for Progress. (The start time of the item)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getStatus

ProcessMonitorItemStatus getStatus()

Get the value for Status. (The status of the ProcessMonitorItem) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getStatusChanged

DateTimeZone getStatusChanged()

Get the value for StatusChanged. (The time when the status of the ProcessMonitorItem last changed) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getDisplayPercentage

Long getDisplayPercentage()

Get the value for DisplayPercentage. (The percentage of the process monitor that this step takes.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getDisplayIndex

Long getDisplayIndex()

Get the value for DisplayIndex. (The index of this item in the branch list.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getDisplayTotal

Long getDisplayTotal()

Get the value for DisplayTotal. (The total number of steps in this process monitor branch.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getParentOffset

Long getParentOffset()

Get the value for ParentOffset. (The parent offset position.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setDisplayOrder

void setDisplayOrder(Long newDisplayOrder)

Set the value for DisplayOrder. (The display order of the item) This value is mandatory.

Parameters:

newDisplayOrder - the new value for DisplayOrder. If this is null, then the object cannot be persisted.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setType

void setType(ProcessMonitorItemType newType)

Set the value for Type. (The type of the Item) This value is mandatory.

Parameters:

newType - the new value for Type. If this is null, then the object cannot be persisted.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setRelatedObject

void setRelatedObject(SchedulerEntity newRelatedObject)

Set the value for RelatedObject. (The SchedulerEntity that is related to this item, or null if no related item, or it has been deleted) This value is optional.

Parameters:

newRelatedObject - the new value for RelatedObject.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setProgressText

void setProgressText(String newProgressText)

Set the value for ProgressText. (The progress text of the ProcessMonitor) This value is optional.

Parameters:

newProgressText - the new value for ProgressText.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setProgressPercentComplete

void setProgressPercentComplete(Long newProgressPercentComplete)

Set the value for ProgressPercentComplete. (The percentage completed of the ProcessMonitor) This value is optional.

Parameters:

newProgressPercentComplete - the new value for ProgressPercentComplete.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setProgressNumber

void setProgressNumber(Long newProgressNumber)

Set the value for ProgressNumber. (The progress as a number) This value is optional.

Parameters:

newProgressNumber - the new value for ProgressNumber.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setProgressNumberMax

void setProgressNumberMax(Long newProgressNumberMax)

Set the value for ProgressNumberMax. (The progress number maximum) This value is optional.

Parameters:

newProgressNumberMax - the new value for ProgressNumberMax.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setProgressStatus

void setProgressStatus(JobStatus newProgressStatus)

Set the value for ProgressStatus. (The final status the item) This value is optional.

Parameters:

newProgressStatus - the new value for ProgressStatus.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setProgressStart

void setProgressStart(DateTimeZone newProgressStart)

Set the value for ProgressStart. (The start time of the item) This value is optional.

Parameters:

newProgressStart - the new value for ProgressStart.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setProgressEnd

void setProgressEnd(DateTimeZone newProgressEnd)

Set the value for ProgressEnd. (The start time of the item) This value is optional.

Parameters:

newProgressEnd - the new value for ProgressEnd.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

incrementStartCount

void incrementStartCount()

Increments the start count.

setCalculatedStatus

void setCalculatedStatus()

Sets the Status to the value calculated from the relative object.

start

void start()

Start the ProcessMonitorItem.

finish

void finish()

Finish the ProcessMonitorItem.

getProcessMonitor

ProcessMonitor getProcessMonitor()

Get the ProcessMonitor.

Returns:

ProcessMonitor

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

getRelatedObjectDefinition

ObjectDefinition getRelatedObjectDefinition()

Get the RelatedObjectDefinition.

Returns:

RelatedObjectDefinition

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setRelatedObjectDefinition

void setRelatedObjectDefinition(ObjectDefinition newRelatedObjectDefinition)

Set the value for RelatedObjectDefinition. This value is optional.

Parameters:

newRelatedObjectDefinition - is the object to set RelatedObjectDefinition to. What type of object the process monitor item is related to?