Package com.redwood.scheduler.api.model

Interface UserMessageDefinition

All Superinterfaces:

BusinessKeyObject, JobDefinitionRelatedObject, Readable, Root, SchedulerEntity, SchedulerEntityComp, UserMessageDefinitionComp

public interface UserMessageDefinition
extends UserMessageDefinitionComp, JobDefinitionRelatedObject, Readable

A user message job definition for cooperation

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "UserMessageDefinition" 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<UserMessageDefinition>	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
UserMessageDefinitionAttachment	createUserMessageDefinitionAttachment()	Create a new UserMessageDefinitionAttachment linked to this object.
UserMessageDefinitionParticipant	createUserMessageDefinitionParticipant()	Create a new UserMessageDefinitionParticipant linked to this object.
UserMessageDefinitionResponse	createUserMessageDefinitionResponse()	Create a new UserMessageDefinitionResponse linked to this object.
UserMessageNotificationMethod	getNotifyMethod()	Get the value for NotifyMethod.
Long	getNumAdditionalLines()	Get the value for NumAdditionalLines.
String	getText()	Get the value for Text.
RWIterable<UserMessageDefinitionAttachment>	getUserMessageDefinitionAttachments()	Get an RWIterable over a collection of UserMessageDefinitionAttachments, the collection will be ordered by Description.
RWIterable<UserMessageDefinitionParticipant>	getUserMessageDefinitionParticipants()	Get an RWIterable over an ordered collection of UserMessageDefinitionParticipants.
UserMessageDefinitionResponse	getUserMessageDefinitionResponseByName(String name)	Get the UserMessageDefinitionResponse by UserMessageDefinitionName.
RWIterable<UserMessageDefinitionResponse>	getUserMessageDefinitionResponses()	Get an RWIterable over a collection of UserMessageDefinitionResponses, the collection will be ordered by UniqueId.
boolean	isNotifyUsers()	Deprecated.
void	setNotifyMethod(UserMessageNotificationMethod newNotifyMethod)	Set the value for NotifyMethod.
void	setNotifyUsers(boolean setNotify)	Deprecated.
void	setText(String newText)	Set the value for Text.

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

getBusinessKey

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

getJobDefinition, setJobDefinition

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

getCreationTime, getLastModificationTime, getLastModifierSubject

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

See Also:

Constant Field Values

TYPE

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

getText

String getText()

Get the value for Text. (The text of the UserMessageDefinition.) 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.

getNumAdditionalLines

Long getNumAdditionalLines()

Get the value for NumAdditionalLines. (The number of additional lines to this message.) 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.

getNotifyMethod

UserMessageNotificationMethod getNotifyMethod()

Get the value for NotifyMethod. (The method for notifying users.) 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.

setText

void setText(String newText)

Set the value for Text. (The text of the UserMessageDefinition.) This value is mandatory.

Parameters:

newText - the new value for Text. 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.

setNotifyMethod

void setNotifyMethod(UserMessageNotificationMethod newNotifyMethod)

Set the value for NotifyMethod. (The method for notifying users.) This value is mandatory.

Parameters:

newNotifyMethod - the new value for NotifyMethod. 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.

isNotifyUsers

@Deprecated
boolean isNotifyUsers()

Deprecated.

This method is deprecated, please use getNotifyMethod() instead.

Should users be notified individually with user message changes?

Returns:

True if users should be notified

setNotifyUsers

@Deprecated
void setNotifyUsers(boolean setNotify)

Deprecated.

This method is deprecated, please use setNotifyMethod(com.redwood.scheduler.api.model.enumeration.UserMessageNotificationMethod) instead.

Set if users should be notified individually with user message changes?

Parameters:

setNotify - True to set individual notification, false to set them none

getUserMessageDefinitionResponses

RWIterable<UserMessageDefinitionResponse> getUserMessageDefinitionResponses()

Get an RWIterable over a collection of UserMessageDefinitionResponses, the collection will be ordered by UniqueId. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The reply actions of the UserMessage.

Specified by:

getUserMessageDefinitionResponses in interface UserMessageDefinitionComp

Returns:

An RWIterable over a collection of UserMessageDefinitionResponse objects , the collection will be ordered by UniqueId.

createUserMessageDefinitionResponse

UserMessageDefinitionResponse createUserMessageDefinitionResponse()

Create a new UserMessageDefinitionResponse linked to this object.

Returns:

a new UserMessageDefinitionResponse.

getUserMessageDefinitionResponseByName

UserMessageDefinitionResponse getUserMessageDefinitionResponseByName(String name)

Get the UserMessageDefinitionResponse by UserMessageDefinitionName.

Parameters:

name -

Returns:

the UserMessageDefinitionResponse, or null if it could not be found

getUserMessageDefinitionAttachments

RWIterable<UserMessageDefinitionAttachment> getUserMessageDefinitionAttachments()

Get an RWIterable over a collection of UserMessageDefinitionAttachments, the collection will be ordered by Description. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The files of the UserMessage.

Specified by:

getUserMessageDefinitionAttachments in interface UserMessageDefinitionComp

Returns:

An RWIterable over a collection of UserMessageDefinitionAttachment objects , the collection will be ordered by Description.

createUserMessageDefinitionAttachment

UserMessageDefinitionAttachment createUserMessageDefinitionAttachment()

Create a new UserMessageDefinitionAttachment linked to this object.

Returns:

a new UserMessageDefinitionAttachment.

getUserMessageDefinitionParticipants

RWIterable<UserMessageDefinitionParticipant> getUserMessageDefinitionParticipants()

Get an RWIterable over an ordered collection of UserMessageDefinitionParticipants. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Who can respond to this User Message

Specified by:

getUserMessageDefinitionParticipants in interface UserMessageDefinitionComp

Returns:

An RWIterable over an ordered collection of UserMessageDefinitionParticipant objects .

createUserMessageDefinitionParticipant

UserMessageDefinitionParticipant createUserMessageDefinitionParticipant()

Create a new UserMessageDefinitionParticipant linked to this object.

Returns:

a new UserMessageDefinitionParticipant.