Package com.redwood.scheduler.api.model

Interface UserMessageDefinitionResponse

All Superinterfaces:

Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface UserMessageDefinitionResponse
extends NamedDetailObject, Readable

The reply actions for a user message.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "UserMessageDefinitionResponse" 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<UserMessageDefinitionResponse>	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
String	getGoToStep()	Get the value for GoToStep.
Long	getReturnCode()	Get the value for ReturnCode.
JobStatus	getStatus()	Get the value for Status.
UserMessageDefinition	getUserMessageDefinition()	Get the UserMessageDefinition.
boolean	isReplyRequired()	Get the value for ReplyRequired.
void	setGoToStep(String newGoToStep)	Set the value for GoToStep.
void	setReplyRequired(boolean newReplyRequired)	Set the value for ReplyRequired.
void	setReturnCode(Long newReturnCode)	Set the value for ReturnCode.
void	setStatus(JobStatus newStatus)	Set the value for Status.

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 "UserMessageDefinitionResponse" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<UserMessageDefinitionResponse> 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

getStatus

JobStatus getStatus()

Get the value for Status. (The JobStatus to set on choosing the action (default Completed).) 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.

getGoToStep

String getGoToStep()

Get the value for GoToStep. (The optional step to goto on completion)

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.

getReturnCode

Long getReturnCode()

Get the value for ReturnCode. (The return code to set on the job if this action is selected (default 0)) 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.

isReplyRequired

boolean isReplyRequired()

Get the value for ReplyRequired. (Is getReplyComment() required to be non-null when this response is chosen on an UserMessage.)

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.

setStatus

void setStatus(JobStatus newStatus)

Set the value for Status. (The JobStatus to set on choosing the action (default Completed).) This value is mandatory.

Parameters:

newStatus - the new value for Status. 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.

setGoToStep

void setGoToStep(String newGoToStep)

Set the value for GoToStep. (The optional step to goto on completion) This value is optional.

Parameters:

newGoToStep - the new value for GoToStep.

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.

setReturnCode

void setReturnCode(Long newReturnCode)

Set the value for ReturnCode. (The return code to set on the job if this action is selected (default 0)) This value is mandatory.

Parameters:

newReturnCode - the new value for ReturnCode. 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.

setReplyRequired

void setReplyRequired(boolean newReplyRequired)

Set the value for ReplyRequired. (Is getReplyComment() required to be non-null when this response is chosen on an UserMessage.)

Parameters:

newReplyRequired - the new value for ReplyRequired.

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.

getUserMessageDefinition

UserMessageDefinition getUserMessageDefinition()

Get the UserMessageDefinition.

Returns:

UserMessageDefinition

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.