Package com.adobe.granite.workflow.exec

Interface InboxItem

  • All Known Subinterfaces:
    Task, WorkItem
    @ProviderType
public interface InboxItem
    Defines an item which is available in the workflow inbox

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  InboxItem.Priority
      The possible priority values for InboxItem.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getContentPath()
      Returns the path of the payload's content for this InboxItem if possible.
      java.lang.String getCurrentAssignee()
      Returns the current assignee, respectively the info in which inbox the InboxItem "resides".
      java.util.Date getDueTime()
      Returns the due time of the InboxItem.
      java.lang.String getId()
      Returns the unique identifier for this InboxItem
      java.lang.String getItemSubType()
      Returns the subtype of this InboxItem.
      java.lang.String getItemType()
      Returns the type of this InboxItem.
      InboxItem.Priority getPriority()
      Returns the priority of this InboxItem.
      java.util.Date getProgressBeginTime()
      Returns the progress begin time of the InboxItem
      Status getStatus()
      Returns the status of the InboxItem.
      java.util.Date getTimeEnded()
      Returns the end time of the InboxItem.
      java.util.Date getTimeStarted()
      Returns the start time of the InboxItem.

    • Method Detail

      • getId

        java.lang.String getId()
        Returns the unique identifier for this InboxItem
        Returns:
        the ID

      • getCurrentAssignee

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

      • getTimeStarted

        java.util.Date getTimeStarted()
        Returns the start time of the InboxItem.
        Returns:
        The start time of the InboxItem.

      • getTimeEnded

        java.util.Date getTimeEnded()
        Returns the end time of the InboxItem.
        Returns:
        The end time of the InboxItem.

      • getDueTime

        java.util.Date getDueTime()
        Returns the due time of the InboxItem.
        Returns:
        The due time of the InboxItem

      • getProgressBeginTime

        java.util.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

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

      • getItemSubType

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

      • getContentPath

        java.lang.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