com.appiancorp.suiteapi.process

Class Attachment

java.lang.Object

com.appiancorp.suiteapi.process.Attachment

All Implemented Interfaces:

XMLable, AppianTypeHolder, java.io.Serializable

public class Attachment
extends java.lang.Object
implements XMLable, AppianTypeHolder

Bean used to represent the Process/Task attachment. This bean is used to communicate between the database and Java.

See Also:

AttachmentMediator, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attachment.NamedUrl

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_ATTACHMENT
static int	NO_PERMISSION
static java.lang.Integer	SORT_BY_ATTACHED_BY Constant representing sorting by Attachment AttachedBy field
static java.lang.Integer	SORT_BY_COMMENT Constant representing sorting by Attachment comment field
static java.lang.Integer	SORT_BY_DATE_ATTACHED Constant representing sorting by Attachment DateAttached field
static int	VALID

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
Attachment()

Method Summary

Modifier and Type	Method and Description
void	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.
java.lang.String	getAttachedBy() Returns the username of user creating the attachment.
java.lang.String	getAttachedDocumentSubType() Returns the extension of attached document in case of document attachment.
LocalObject	getAttachedObject() Returns the LocalObject used as attachment.
LocalObject	getAttachedTo() Returns the LocalObject that the attachment is attached to.
java.lang.Long	getAttachedToGuiId()
Attachment.NamedUrl	getAttachedUrl() Returns the NamedUrl representing an external url attachment.
java.lang.String	getComment() Returns the comments for the attachment.
java.sql.Timestamp	getDateAttached() Returns the timestamp for attachment creation.
java.lang.String	getEncodedComment() Returns a URLEncoded comments in accordance with UTF-8 encoding scheme.
java.lang.Long	getId() Returns the Id of attachment
AttachmentPermissions	getPermissions() Returns the permissions for attachment
void	setAttachedBy(java.lang.String attachedBy_) Sets the username of user creating the attachment.
void	setAttachedDocumentSubType(java.lang.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(java.lang.Long attachedToGuiId_)
void	setAttachedUrl(Attachment.NamedUrl attachedUrl_) Sets the NamedUrl Object representing an external url attachment.
void	setComment(java.lang.String comment_) Sets the comments for attachment
void	setDateAttached(java.sql.Timestamp dateAttached_) Sets the attachment creation Timestamp.
void	setId(java.lang.Long id_) Sets the attachment Id.
void	setPermissions(AttachmentPermissions permissions_) Sets the attachment permissions
java.lang.String	toXML() converts the process model to xml as a string
void	toXML(java.lang.StringBuilder buffer_) Appends an XML representation of this model to the given buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Field Detail

SORT_BY_DATE_ATTACHED

public static final java.lang.Integer SORT_BY_DATE_ATTACHED

Constant representing sorting by Attachment DateAttached field

SORT_BY_ATTACHED_BY

public static final java.lang.Integer SORT_BY_ATTACHED_BY

Constant representing sorting by Attachment AttachedBy field

SORT_BY_COMMENT

public static final java.lang.Integer SORT_BY_COMMENT

Constant representing sorting by Attachment comment field

NO_PERMISSION

public static final int NO_PERMISSION

See Also:

Constant Field Values

INVALID_ATTACHMENT

public static final int INVALID_ATTACHMENT

See Also:

Constant Field Values

VALID

public static final int VALID

See Also:

Constant Field Values

Constructor Detail

Attachment

public Attachment()

Method Detail

getAttachedBy

public java.lang.String getAttachedBy()

Returns the username of user creating the attachment.

Returns:

username

toXML

public void toXML(java.lang.StringBuilder buffer_)

Appends an XML representation of this model to the given buffer.

Specified by:

toXML in interface XMLable

Parameters:

buffer_ - The buffer on which to append the XML representation.

fillInAppianTypes

public void fillInAppianTypes(AppianTypeCache cache_)

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 interface AppianTypeHolder

Parameters:

cache_ - cache of Appian-typed objects.

toXML

public java.lang.String toXML()

converts the process model to xml as a string

Specified by:

toXML in interface XMLable

Returns:

The XML representation of this object.

setAttachedBy

public void setAttachedBy(java.lang.String attachedBy_)

Sets the username of user creating the attachment.

Parameters:

attachedBy_ - username to set.

getAttachedObject

public LocalObject getAttachedObject()

Returns the LocalObject used as attachment.

Returns:

LocalObject representing Appian Object.

setAttachedObject

public void setAttachedObject(LocalObject attachedObject_)

Sets the LocalObject used as attachment.

Parameters:

attachedObject_ - LocalObject.

getAttachedTo

public LocalObject getAttachedTo()

Returns the LocalObject that the attachment is attached to.

Returns:

LocalObject representing attachedTo Object.

setAttachedTo

public void setAttachedTo(LocalObject attachedTo_)

Sets the LocalObject that the attachment is attached.

Parameters:

attachedTo_ - attachedTo LocalObject

getAttachedToGuiId

public java.lang.Long getAttachedToGuiId()

Returns:

Returns the attachedToGuiId.

setAttachedToGuiId

public void setAttachedToGuiId(java.lang.Long attachedToGuiId_)

Parameters:

attachedToGuiId_ - The attachedToGuiId to set.

getAttachedUrl

public Attachment.NamedUrl getAttachedUrl()

Returns the NamedUrl representing an external url attachment.

Returns:

NamedUrl Object

setAttachedUrl

public void setAttachedUrl(Attachment.NamedUrl attachedUrl_)

Sets the NamedUrl Object representing an external url attachment.

Parameters:

attachedUrl_ - NamedUrl Object representing an external url.

getComment

public java.lang.String getComment()

Returns the comments for the attachment.

Returns:

comments.

setComment

public void setComment(java.lang.String comment_)

Sets the comments for attachment

Parameters:

comment_ - Comments to set.

getDateAttached

public java.sql.Timestamp getDateAttached()

Returns the timestamp for attachment creation.

Returns:

attachment creation Timestamp

setDateAttached

public void setDateAttached(java.sql.Timestamp dateAttached_)

Sets the attachment creation Timestamp.

Parameters:

dateAttached_ - Timestamp to set.

getId

public java.lang.Long getId()

Returns the Id of attachment

Returns:

attachment Id

setId

public void setId(java.lang.Long id_)

Sets the attachment Id.

Parameters:

id_ - attachment id to set.

getPermissions

public AttachmentPermissions getPermissions()

Returns the permissions for attachment

Returns:

attachment permissions

setPermissions

public void setPermissions(AttachmentPermissions permissions_)

Sets the attachment permissions

Parameters:

permissions_ - attachment permissions to set.

getAttachedDocumentSubType

public java.lang.String getAttachedDocumentSubType()

Returns the extension of attached document in case of document attachment.

Returns:

document extension

setAttachedDocumentSubType

public void setAttachedDocumentSubType(java.lang.String attachedDocumentSubType_)

Sets the extension of document in case of document attachment.

Parameters:

attachedDocumentSubType_ - extension of document.

getEncodedComment

public java.lang.String getEncodedComment()

Returns a URLEncoded comments in accordance with UTF-8 encoding scheme.

Returns:

URLEncoded attachment comments