Interface InboxItem

  • All Known Subinterfaces:
    Task, WorkItem

    @ProviderType
    public interface InboxItem
    Defines an item which is available in the workflow inbox
    • Method Detail

      • getId

        String getId()
        Returns the unique identifier for this InboxItem
        Returns:
        the ID
      • getCurrentAssignee

        String getCurrentAssignee()
        Returns the current assignee, respectively the info in which inbox the InboxItem "resides".
        Returns:
        current assignee
      • getTimeStarted

        Date getTimeStarted()
        Returns the start time of the InboxItem.
        Returns:
        The start time of the InboxItem.
      • getTimeEnded

        Date getTimeEnded()
        Returns the end time of the InboxItem.
        Returns:
        The end time of the InboxItem.
      • getDueTime

        Date getDueTime()
        Returns the due time of the InboxItem.
        Returns:
        The due time of the InboxItem
      • getProgressBeginTime

        Date getProgressBeginTime()
        Returns the progress begin time of the InboxItem
        Returns:
        The progress begin time of the InboxItem
      • getStatus

        Status getStatus()
        Returns the status of the InboxItem.
        Returns:
        the status of the InboxItem
      • getItemType

        String getItemType()
        Returns the type of this InboxItem. Different implementations of InboxItem should return unique values
        Returns:
        the item type
      • getItemSubType

        String getItemSubType()
        Returns the subtype of this InboxItem.
        Returns:
        the subtype of this item, or null if there is no subtype.
      • getContentPath

        String getContentPath()
        Returns the path of the payload's content for this InboxItem if possible. If the payload's content is not stored as a path then null is returned.
        Returns:
        the payload's content path or null.
      • getPriority

        InboxItem.Priority getPriority()
        Returns the priority of this InboxItem.
        Returns:
        the priority of this InboxItem