Package com.redwood.scheduler.api.model

Interface UserMessageDefinitionAttachment

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface UserMessageDefinitionAttachment
extends Detail, Readable

The files to attach to a UserMessageDefinition

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "UserMessageDefinitionAttachment" 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<UserMessageDefinitionAttachment>	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	getDescription()	Get the value for Description.
String	getSpecification()	Get the value for Specification.
UserMessageDefinition	getUserMessageDefinition()	Get the UserMessageDefinition.
boolean	isAttachToNotification()	Get the value for AttachToNotification.
void	setAttachToNotification(boolean newAttachToNotification)	Set the value for AttachToNotification.
void	setDescription(String newDescription)	Set the value for Description.
void	setSpecification(String newSpecification)	Set the value for Specification.

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

See Also:

Constant Field Values

TYPE

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

getSpecification

String getSpecification()

Get the value for Specification. (The specification for the File) 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.

getDescription

String getDescription()

Get the value for Description. (The description for the File) 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.

isAttachToNotification

boolean isAttachToNotification()

Get the value for AttachToNotification. (Attach to the notification email?)

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.

setSpecification

void setSpecification(String newSpecification)

Set the value for Specification. (The specification for the File) This value is mandatory.

Parameters:

newSpecification - the new value for Specification. 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.

setDescription

void setDescription(String newDescription)

Set the value for Description. (The description for the File) This value is mandatory.

Parameters:

newDescription - the new value for Description. 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.

setAttachToNotification

void setAttachToNotification(boolean newAttachToNotification)

Set the value for AttachToNotification. (Attach to the notification email?)

Parameters:

newAttachToNotification - the new value for AttachToNotification.

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.