AttachmentMediator (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.process.AttachmentMediator

All Implemented Interfaces:

java.io.Serializable
```
public class AttachmentMediator
extends java.lang.Object
implements java.io.Serializable
```
Bean used to represent the Process/Task attachment. It is used to communicate between UI and Java layers.

See Also:

Attachment, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AttachmentMediator()

Constructors
Constructor and Description
`AttachmentMediator()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getAttachedAtDesignTime()` Returns whether the LocalObject `LocalObject` was attached at design time.
`java.lang.String`	`getAttachedBy()` Returns the `username` of user `User` who created the attachment.
`java.lang.String`	`getAttachedDocumentSubType()` Returns the `extension` of attached document `Document` in case of `Document` attachment.
`LocalObject`	`getAttachedObject()` Returns the attached LocalObject `LocalObject`.
`LocalObject`	`getAttachedTo()` Returns the LocalObject `LocalObject` that the attachment is attached to.
`Attachment.NamedUrl`	`getAttachedUrl()` Returns the NamedUrl Object `Attachment.NamedUrl` representing an attached external url.
`java.lang.String`	`getComment()` Returns the comments added to the attachment.
`java.sql.Timestamp`	`getDateAttached()` Returns the date when the attachment was created.
`java.lang.String`	`getDisplayName()` Returns the display name for attachment.
`java.lang.String`	`getEncodedComment()` Returns a URLEncoded comments in accordance with UTF-8 encoding scheme.
`java.lang.Long`	`getId()` Returns the id of attachment.
`static AttachmentMediator`	`getMediatorFromAttachment(Attachment attachment_)` Converts an `Attachment` to AttachmentMediator `AttachmentMediator` and returns an `AttachmentMediator`
`AttachmentPermissions`	`getPermissions()` Returns the attachment permissions `AttachmentPermissions`
`java.lang.Boolean`	`getProcessAttachment()` Returns whether the attachment is a process attachment or not.
`java.lang.String`	`getType()` Returns the string display of the type
`void`	`setAttachedAtDesignTime(java.lang.Boolean attachedAtDesignTime_)` Sets whether the LocalObject `LocalObject` was attached at design time.
`void`	`setAttachedBy(java.lang.String attachedBy_)` Sets the `username` of user `User` creating the attachment.
`void`	`setAttachedDocumentSubType(java.lang.String attachedDocumentSubType_)` Sets the `extension` of document `Document` in case of `document` attachment.
`void`	`setAttachedObject(LocalObject atachedObject_)` Sets the LocalObject `LocalObject`.
`void`	`setAttachedTo(LocalObject attachedTo_)` Sets the LocalObject `LocalObject` that the attachment is attached to.
`void`	`setAttachedUrl(Attachment.NamedUrl attachedUrl_)` Sets the NamedUrl object `Attachment.NamedUrl` representing an external url.
`void`	`setComment(java.lang.String comment_)` Sets the comments for the attachment been added.
`void`	`setDateAttached(java.sql.Timestamp dateAttached_)` Sets the date of creation for attachment
`void`	`setDisplayName(java.lang.String displayName_)` Sets the display name for attachment.
`void`	`setId(java.lang.Long id_)` Sets the id of attachment.
`void`	`setPermissions(AttachmentPermissions permissions_)` Sets the attachment permissions `AttachmentPermissions`
`void`	`setProcessAttachment(java.lang.Boolean isProcessAttachment_)` Sets whether the attachment is process attachment or not.
`void`	`setType(java.lang.String type_)` Sets the string display of the type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AttachmentMediator
```
public AttachmentMediator()
```
- Method Detail
  - getType
```
public java.lang.String getType()
```
    Returns the string display of the type
    
    Returns:
    
    the string display of the type.
  - setType
```
public void setType(java.lang.String type_)
```
    Sets the string display of the type.
    
    Parameters:
    
    type_ - the string display of the type.
  - getAttachedObject
```
public LocalObject getAttachedObject()
```
    Returns the attached LocalObject LocalObject.
    
    Returns:
    
    attached LocalObject.
  - setAttachedObject
```
public void setAttachedObject(LocalObject atachedObject_)
```
    Sets the LocalObject LocalObject.
    
    Parameters:
    
    atachedObject_ - LocalObject to set.
  - getAttachedAtDesignTime
```
public java.lang.Boolean getAttachedAtDesignTime()
```
    Returns whether the LocalObject LocalObject was attached at design time.
    
    Returns:
    
    true if LocalObject was attached at design time, else false.
  - setAttachedAtDesignTime
```
public void setAttachedAtDesignTime(java.lang.Boolean attachedAtDesignTime_)
```
    Sets whether the LocalObject LocalObject was attached at design time.
    
    Parameters:
    
    attachedAtDesignTime_ - true if attaching at design time, else false.
  - getAttachedBy
```
public java.lang.String getAttachedBy()
```
    Returns the username of user User who created the attachment.
    
    Returns:
    
    username.
  - setAttachedBy
```
public void setAttachedBy(java.lang.String attachedBy_)
```
    Sets the username of user User creating the attachment.
    
    Parameters:
    
    attachedBy_ - username of user.
  - getAttachedDocumentSubType
```
public java.lang.String getAttachedDocumentSubType()
```
    Returns the extension of attached document Document in case of Document attachment.
    
    Returns:
    
    document extension.
  - setAttachedDocumentSubType
```
public void setAttachedDocumentSubType(java.lang.String attachedDocumentSubType_)
```
    Sets the extension of document Document in case of document attachment.
    
    Parameters:
    
    attachedDocumentSubType_ - extension of document.
  - getAttachedTo
```
public LocalObject getAttachedTo()
```
    Returns the LocalObject LocalObject that the attachment is attached to.
    
    Returns:
    
    AttachedTo LocalObject
  - setAttachedTo
```
public void setAttachedTo(LocalObject attachedTo_)
```
    Sets the LocalObject LocalObject that the attachment is attached to.
    
    Parameters:
    
    attachedTo_ - LocalObject
  - getAttachedUrl
```
public Attachment.NamedUrl getAttachedUrl()
```
    Returns the NamedUrl Object Attachment.NamedUrl representing an attached external url.
    
    Returns:
    
    NamedUrl representing external url.
  - setAttachedUrl
```
public void setAttachedUrl(Attachment.NamedUrl attachedUrl_)
```
    Sets the NamedUrl object Attachment.NamedUrl representing an external url.
    
    Parameters:
    
    attachedUrl_ - NamedUrl Object to set.
  - getComment
```
public java.lang.String getComment()
```
    Returns the comments added to the attachment.
    
    Returns:
    
    attachment comments.
  - setComment
```
public void setComment(java.lang.String comment_)
```
    Sets the comments for the attachment been added.
    
    Parameters:
    
    comment_ - comments to set.
  - getDateAttached
```
public java.sql.Timestamp getDateAttached()
```
    Returns the date when the attachment was created.
    
    Returns:
    
    Returns attachment creation date.
  - setDateAttached
```
public void setDateAttached(java.sql.Timestamp dateAttached_)
```
    Sets the date of creation for attachment
    
    Parameters:
    
    dateAttached_ - Creation date.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Returns the display name for attachment.
    
    Returns:
    
    the display name.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName_)
```
    Sets the display name for attachment.
    
    Parameters:
    
    displayName_ - display name to set.
  - getId
```
public java.lang.Long getId()
```
    Returns the id of attachment.
    
    Returns:
    
    Returns the attachment id.
  - setId
```
public void setId(java.lang.Long id_)
```
    Sets the id of attachment.
    
    Parameters:
    
    id_ - attachment id to set.
  - getProcessAttachment
```
public java.lang.Boolean getProcessAttachment()
```
    Returns whether the attachment is a process attachment or not.
    
    Returns:
    
    true if the attachment is added to process else false.
  - setProcessAttachment
```
public void setProcessAttachment(java.lang.Boolean isProcessAttachment_)
```
    Sets whether the attachment is process attachment or not.
    
    Parameters:
    
    isProcessAttachment_ - true if attachment is process attachment, else false.
  - getPermissions
```
public AttachmentPermissions getPermissions()
```
    Returns the attachment permissions AttachmentPermissions
    
    Returns:
    
    permissions for attachment
  - setPermissions
```
public void setPermissions(AttachmentPermissions permissions_)
```
    Sets the attachment permissions AttachmentPermissions
    
    Parameters:
    
    permissions_ - attachment permissions
  - getMediatorFromAttachment
```
public static AttachmentMediator getMediatorFromAttachment(Attachment attachment_)
```
    Converts an Attachment to AttachmentMediator AttachmentMediator and returns an AttachmentMediator
    
    Parameters:
    
    attachment_ - Attachment to convert.
    
    Returns:
    
    AttachmentMediator Object
  - getEncodedComment
```
public java.lang.String getEncodedComment()
```
    Returns a URLEncoded comments in accordance with UTF-8 encoding scheme.
    
    Returns:
    
    URLEncoded attachment comments

Class AttachmentMediator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AttachmentMediator

Method Detail

getType

setType

getAttachedObject

setAttachedObject

getAttachedAtDesignTime

setAttachedAtDesignTime

getAttachedBy

setAttachedBy

getAttachedDocumentSubType

setAttachedDocumentSubType

getAttachedTo

setAttachedTo

getAttachedUrl

setAttachedUrl

getComment

setComment

getDateAttached

setDateAttached

getDisplayName

setDisplayName

getId

setId

getProcessAttachment

setProcessAttachment

getPermissions

setPermissions

getMediatorFromAttachment

getEncodedComment