Package com.appiancorp.suiteapi.process

Class AttachmentMediator

java.lang.Object
com.appiancorp.suiteapi.process.AttachmentMediator
All Implemented Interfaces:
Serializable
public class AttachmentMediator extends Object implements Serializable
Bean used to represent the Process/Task attachment. It is used to communicate between UI and Java layers.
See Also:

  • Constructor Details

    • AttachmentMediator

      public AttachmentMediator()

  • Method Details

    • getType

      public String getType()
      Returns the string display of the type
      Returns:
      the string display of the type.

    • setType

      public void setType(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 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(Boolean attachedAtDesignTime_)
      Sets whether the LocalObject LocalObject was attached at design time.
      Parameters:
      attachedAtDesignTime_ - true if attaching at design time, else false.

    • getAttachedBy

      public String getAttachedBy()
      Returns the username of user User who created the attachment.
      Returns:
      username.

    • setAttachedBy

      public void setAttachedBy(String attachedBy_)
      Sets the username of user User creating the attachment.
      Parameters:
      attachedBy_ - username of user.

    • getAttachedDocumentSubType

      public String getAttachedDocumentSubType()
      Returns the extension of attached document Document in case of Document attachment.
      Returns:
      document extension.

    • setAttachedDocumentSubType

      public void setAttachedDocumentSubType(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 String getComment()
      Returns the comments added to the attachment.
      Returns:
      attachment comments.

    • setComment

      public void setComment(String comment_)
      Sets the comments for the attachment been added.
      Parameters:
      comment_ - comments to set.

    • getDateAttached

      public Timestamp getDateAttached()
      Returns the date when the attachment was created.
      Returns:
      Returns attachment creation date.

    • setDateAttached

      public void setDateAttached(Timestamp dateAttached_)
      Sets the date of creation for attachment
      Parameters:
      dateAttached_ - Creation date.

    • getDisplayName

      public String getDisplayName()
      Returns the display name for attachment.
      Returns:
      the display name.

    • setDisplayName

      public void setDisplayName(String displayName_)
      Sets the display name for attachment.
      Parameters:
      displayName_ - display name to set.

    • getId

      public Long getId()
      Returns the id of attachment.
      Returns:
      Returns the attachment id.

    • setId

      public void setId(Long id_)
      Sets the id of attachment.
      Parameters:
      id_ - attachment id to set.

    • getProcessAttachment

      public 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(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 String getEncodedComment()
      Returns a URLEncoded comments in accordance with UTF-8 encoding scheme.
      Returns:
      URLEncoded attachment comments