Interface Attachment

  • All Known Implementing Classes:
    AttachmentEntity

    public interface Attachment
    Any type of content that is be associated with a task or with a process instance.
    Author:
    Tom Baeyens
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Date getCreateTime()
      The time when the attachment was created.
      String getDescription()
      long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
      String getId()
      unique id for this attachment
      String getName()
      free user defined short (max 255 chars) name for this attachment
      String getProcessInstanceId()
      reference to the process instance to which this attachment is associated.
      Date getRemovalTime()
      The time the historic attachment will be removed.
      String getRootProcessInstanceId()
      reference to the root process instance id of the process instance on which this attachment was made
      String getTaskId()
      reference to the task to which this attachment is associated.
      String getType()
      indication of the type of content that this attachment refers to.
      String getUrl()
      the remote URL in case this is remote content.
      void setDescription​(String description)
      long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
      void setName​(String name)
      free user defined short (max 255 chars) name for this attachment
    • Method Detail

      • getId

        String getId()
        unique id for this attachment
      • getName

        String getName()
        free user defined short (max 255 chars) name for this attachment
      • setName

        void setName​(String name)
        free user defined short (max 255 chars) name for this attachment
      • getDescription

        String getDescription()
        long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
      • setDescription

        void setDescription​(String description)
        long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
      • getType

        String getType()
        indication of the type of content that this attachment refers to. Can be mime type or any other indication.
      • getTaskId

        String getTaskId()
        reference to the task to which this attachment is associated.
      • getProcessInstanceId

        String getProcessInstanceId()
        reference to the process instance to which this attachment is associated.
      • getCreateTime

        Date getCreateTime()
        The time when the attachment was created.
      • getRootProcessInstanceId

        String getRootProcessInstanceId()
        reference to the root process instance id of the process instance on which this attachment was made
      • getRemovalTime

        Date getRemovalTime()
        The time the historic attachment will be removed.