Package com.redwood.scheduler.api.model

Interface UserMessageHistory

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

public interface UserMessageHistory
extends Detail

The history of the forward and delegation of a user message.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "UserMessageHistory" 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<UserMessageHistory>	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
UserMessageFlowAction	getAction()	Get the value for Action.
String	getComment()	Get the value for Comment.
DateTimeZone	getCreationTime()	Get the value for CreationTime.
Subject	getReceiverSubject()	Get the ReceiverSubject.
Subject	getSenderSubject()	Get the SenderSubject.
UserMessage	getUserMessage()	Get the UserMessage.
void	setAction(UserMessageFlowAction newAction)	Set the value for Action.
void	setComment(String newComment)	Set the value for Comment.
void	setReceiverSubject(Subject newReceiverSubject)	Set the value for ReceiverSubject.

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

See Also:

Constant Field Values

TYPE

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

getAction

UserMessageFlowAction getAction()

Get the value for Action. (The action undertaken) 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.

getComment

String getComment()

Get the value for Comment. (Optional comment.)

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.

getCreationTime

DateTimeZone getCreationTime()

Get the value for CreationTime. (When was the history record created)

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.

setAction

void setAction(UserMessageFlowAction newAction)

Set the value for Action. (The action undertaken) This value is mandatory.

Parameters:

newAction - the new value for Action. 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.

setComment

void setComment(String newComment)

Set the value for Comment. (Optional comment.) This value is optional.

Parameters:

newComment - the new value for Comment.

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.

getUserMessage

UserMessage getUserMessage()

Get the UserMessage.

Returns:

UserMessage

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.

getSenderSubject

Subject getSenderSubject()

Get the SenderSubject.

Returns:

SenderSubject

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.

getReceiverSubject

Subject getReceiverSubject()

Get the ReceiverSubject.

Returns:

ReceiverSubject

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.

setReceiverSubject

void setReceiverSubject(Subject newReceiverSubject)

Set the value for ReceiverSubject. This value is mandatory.

Parameters:

newReceiverSubject - is the object to set ReceiverSubject to. The related UserMessage job that created this user message If this is null, then the object cannot be persisted.