Package com.appiancorp.suiteapi.process
Class Attachment
java.lang.Object
com.appiancorp.suiteapi.process.Attachment
- All Implemented Interfaces:
XMLable
,AppianTypeHolder
,Serializable
Bean used to represent the Process/Task attachment. This bean is used to
communicate between the database and Java.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final Integer
Constant representing sorting by Attachment AttachedBy fieldstatic final Integer
Constant representing sorting by Attachment comment fieldstatic final Integer
Constant representing sorting by Attachment DateAttached fieldstatic final int
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
fillInAppianTypes
(AppianTypeCache cache_) If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache.Returns the username of user creating the attachment.Returns the extension of attached document in case of document attachment.Returns the LocalObject used as attachment.Returns the LocalObject that the attachment is attached to.Returns the NamedUrl representing an external url attachment.Returns the comments for the attachment.Returns the timestamp for attachment creation.Returns a URLEncoded comments in accordance with UTF-8 encoding scheme.getId()
Returns the Id of attachmentReturns the permissions for attachmentvoid
setAttachedBy
(String attachedBy_) Sets the username of user creating the attachment.void
setAttachedDocumentSubType
(String attachedDocumentSubType_) Sets the extension of document in case of document attachment.void
setAttachedObject
(LocalObject attachedObject_) Sets the LocalObject used as attachment.void
setAttachedTo
(LocalObject attachedTo_) Sets the LocalObject that the attachment is attached.void
setAttachedToGuiId
(Long attachedToGuiId_) void
setAttachedUrl
(Attachment.NamedUrl attachedUrl_) Sets the NamedUrl Object representing an external url attachment.void
setComment
(String comment_) Sets the comments for attachmentvoid
setDateAttached
(Timestamp dateAttached_) Sets the attachment creation Timestamp.void
Sets the attachment Id.void
setPermissions
(AttachmentPermissions permissions_) Sets the attachment permissionstoXML()
converts the process model to xml as a stringvoid
toXML
(StringBuilder buffer_) Appends an XML representation of this model to the given buffer.
-
Field Details
-
SORT_BY_DATE_ATTACHED
Constant representing sorting by Attachment DateAttached field -
SORT_BY_ATTACHED_BY
Constant representing sorting by Attachment AttachedBy field -
SORT_BY_COMMENT
Constant representing sorting by Attachment comment field -
NO_PERMISSION
public static final int NO_PERMISSION- See Also:
-
INVALID_ATTACHMENT
public static final int INVALID_ATTACHMENT- See Also:
-
VALID
public static final int VALID- See Also:
-
-
Constructor Details
-
Attachment
public Attachment()
-
-
Method Details
-
getAttachedBy
Returns the username of user creating the attachment.- Returns:
- username
-
toXML
Appends an XML representation of this model to the given buffer. -
fillInAppianTypes
Description copied from interface:AppianTypeHolder
If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache. Later, the cache will populate itself with the display strings that correspond to all of its ids, such as "Human Resources" for group 9.- Specified by:
fillInAppianTypes
in interfaceAppianTypeHolder
- Parameters:
cache_
- cache of Appian-typed objects.
-
toXML
converts the process model to xml as a string -
setAttachedBy
Sets the username of user creating the attachment.- Parameters:
attachedBy_
- username to set.
-
getAttachedObject
Returns the LocalObject used as attachment.- Returns:
- LocalObject representing Appian Object.
-
setAttachedObject
Sets the LocalObject used as attachment.- Parameters:
attachedObject_
- LocalObject.
-
getAttachedTo
Returns the LocalObject that the attachment is attached to.- Returns:
- LocalObject representing attachedTo Object.
-
setAttachedTo
Sets the LocalObject that the attachment is attached.- Parameters:
attachedTo_
- attachedTo LocalObject
-
getAttachedToGuiId
- Returns:
- Returns the attachedToGuiId.
-
setAttachedToGuiId
- Parameters:
attachedToGuiId_
- The attachedToGuiId to set.
-
getAttachedUrl
Returns the NamedUrl representing an external url attachment.- Returns:
- NamedUrl Object
-
setAttachedUrl
Sets the NamedUrl Object representing an external url attachment.- Parameters:
attachedUrl_
- NamedUrl Object representing an external url.
-
getComment
Returns the comments for the attachment.- Returns:
- comments.
-
setComment
Sets the comments for attachment- Parameters:
comment_
- Comments to set.
-
getDateAttached
Returns the timestamp for attachment creation.- Returns:
- attachment creation Timestamp
-
setDateAttached
Sets the attachment creation Timestamp.- Parameters:
dateAttached_
- Timestamp to set.
-
getId
Returns the Id of attachment- Returns:
- attachment Id
-
setId
Sets the attachment Id.- Parameters:
id_
- attachment id to set.
-
getPermissions
Returns the permissions for attachment- Returns:
- attachment permissions
-
setPermissions
Sets the attachment permissions- Parameters:
permissions_
- attachment permissions to set.
-
getAttachedDocumentSubType
Returns the extension of attached document in case of document attachment.- Returns:
- document extension
-
setAttachedDocumentSubType
Sets the extension of document in case of document attachment.- Parameters:
attachedDocumentSubType_
- extension of document.
-
getEncodedComment
Returns a URLEncoded comments in accordance with UTF-8 encoding scheme.- Returns:
- URLEncoded attachment comments
-