Package com.redwood.scheduler.api.model

Interface UserMessageAttachment

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

public interface UserMessageAttachment
extends Detail

The links to file for this message

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "UserMessageAttachment" 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<UserMessageAttachment>	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
UserMessageAttachmentType	getAttachmentType()	Get the value for AttachmentType.
String	getDescription()	Get the value for Description.
Document	getDocument()	Attempts to return the Document that is the attachment.
JobFile	getJobFile()	Attempts to return the Job File that the attachment.
String	getLink()	Get the value for Link.
UserMessage	getUserMessage()	Get the UserMessage.
boolean	isAttachToNotification()	Get the value for AttachToNotification.
void	setAttachmentType(UserMessageAttachmentType newAttachmentType)	Set the value for AttachmentType.
void	setAttachToNotification(boolean newAttachToNotification)	Set the value for AttachToNotification.
void	setDescription(String newDescription)	Set the value for Description.
void	setDocument(Document document)	Set the attachment to a Document
void	setLink(String newLink)	Set the value for Link.
UserMessageAttachmentUpload	startUpload(Format format)	Start an upload of an attachment.

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

See Also:

Constant Field Values

TYPE

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

getDescription

String getDescription()

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

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

getLink

String getLink()

Get the value for Link. (The link to 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:

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:

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

getAttachmentType

UserMessageAttachmentType getAttachmentType()

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

Returns:

the field

Throws:

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 of the file) This value is mandatory.

Parameters:

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

Throws:

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

setLink

void setLink(String newLink)

Set the value for Link. (The link to the file) This value is mandatory.

Parameters:

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

Throws:

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:

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

setAttachmentType

void setAttachmentType(UserMessageAttachmentType newAttachmentType)

Set the value for AttachmentType. (The type of the attachment) This value is mandatory.

Parameters:

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

Throws:

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

getJobFile

JobFile getJobFile()
            throws UserMessageAttachmentException

Attempts to return the Job File that the attachment.

Returns:

The Job File if it exists, or null if the link isn't not of the appropriate type, or cannot be found

Throws:

UserMessageAttachmentException - The user message attachment upload was denied or failed.

getDocument

Document getDocument()
              throws UserMessageAttachmentException

Attempts to return the Document that is the attachment.

Returns:

The Document if it exists, or null if the Document cannot be found.

Throws:

UserMessageAttachmentException - The user message attachment upload was denied or failed.

setDocument

void setDocument(Document document)

Set the attachment to a Document

Parameters:

document - The Document to add as the attachment

startUpload

UserMessageAttachmentUpload startUpload(Format format)
                                 throws UserMessageAttachmentException

Start an upload of an attachment.

Parameters:

format - The format of the attachment file

Returns:

Return a UserMessageAttachmentUpload object to control the upload process.

Throws:

UserMessageAttachmentException - The user message attachment upload was denied or failed.

getUserMessage

UserMessage getUserMessage()

Get the UserMessage.

Returns:

UserMessage

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.