Package com.adobe.cq.inbox.ui

Interface InboxItem

public interface InboxItem
Represents an inbox item of either type task or workitem.

  • Method Details

    • getTitle

      String getTitle()
      Returns the item title.
      Returns:
      item title

    • getDescription

      String getDescription()
      Returns the item description.
      Returns:
      item description

    • getPath

      String getPath()
      Returns the item path.
      Returns:
      item path

    • getResourceType

      String getResourceType()
      Returns the item resource type.
      Returns:
      item resource type

    • getCurrentAssigneeInfo

      Map<String,String> getCurrentAssigneeInfo()
      Returns a Map containing information about the current assignee.
      Returns:
      a map of key/value pairs or null

    • getPayloadLink

      String getPayloadLink()
      Returns the payload link.
      Returns:
      payload link or null

    • getPayloadPath

      String getPayloadPath()
      Returns the payload path in the repository.
      Returns:
      payload path or null

    • getPayloadThumbnail

      String getPayloadThumbnail()
      Returns the payload thumbnail path. If the payload has no payload thumbnail, null is returned.
      Returns:
      payload thumbnail path or null

    • isPayloadFolder

      boolean isPayloadFolder()
      Indicates if referenced payload is of type folder.
      Returns:
      true if payload is of type folder, false otherwise

    • getThumbnail

      String getThumbnail()
      Returns the thumbnail path. If no project is associated with this task null is returned.
      Returns:
      thumbnail path or null

    • getPriority

      String getPriority()
      Returns the task priority. Either 'High', 'Medium' or 'Low'.
      Returns:
      task priority or null

    • getPriorityIcon

      String getPriorityIcon()
      Returns the task priority icon identifier. Either 'arrowUp' or 'arrowDown'.
      Returns:
      task priority icon identifier or null

    • getPriorityStyle

      String getPriorityStyle()
      Returns the task priority style class name. Either 'inbox-item-priority--high', 'inbox-item-priority--normal' or 'inbox-item-priority--low'.
      Returns:
      task priority style class name

    • getStatus

      String getStatus()
      Returns the task status. Either 'Active', 'Complete' or 'Terminated'.
      Returns:
      task status

    • getStatusIcon

      String getStatusIcon()
      Returns the task status icon. Either 'clock', 'checkCircle' or 'alert'.
      Returns:
      task status icon name

    • getStatusType

      String getStatusType()
      Returns the task status type. Either 'inbox-status-active' or 'inbox-status-complete'.
      Returns:
      task status type or an empty String

    • getDetailsUrl

      String getDetailsUrl()
      Returns the task details URL.
      Returns:
      task details URL

    • getProjectId

      String getProjectId()
      Returns the task project identifier if task is related to a project.
      Returns:
      project identifier or null

    • getProjectTitle

      String getProjectTitle()
      Returns the task project title if task is related to a project.
      Returns:
      task project title or null

    • getAssociatedProjectDetailsUrl

      String getAssociatedProjectDetailsUrl()
      Returns the task project URL if task is related to a project.
      Returns:
      task project URL or null

    • getWorkflowTitle

      String getWorkflowTitle()
      Returns the workflow title if task is related to a workflow.
      Returns:
      task workflow title or null

    • getWorkflowInitiator

      String getWorkflowInitiator()
      Returns the workflow initiator identifier if task is related to a workflow.
      Returns:
      workflow initiator identifier or null

    • getStartDate

      Date getStartDate()
      Returns the task start date.
      Returns:
      task start date

    • getDueDate

      Date getDueDate()
      Returns the task due date.
      Returns:
      task due date

    • getDueDateColor

      String getDueDateColor()
      Returns the due date color name. Either 'red' or 'orange'.
      Returns:
      due date color name or null

    • getQuickactionsRel

      Set<String> getQuickactionsRel()
      Returns the quickaction relation identifiers.
      Returns:
      quickaction relation itendifiers or an empty Set.

    • getTaskActions

      String getTaskActions()
      Returns the task actions as serialized JSONArray in the following form.

      [{actionName:'Action', actionId:'ID'},...]

      Returns:
      task actions

    • isShared

      boolean isShared()
      Returns whether this inbox item is shared or not. Sharing may be explicit or via inbox sharing. i.e. it will return true if - this inbox item has been explicitly shared - or the assignee of the inbox item is sharing his inbox
      Returns:
      whether the inbox item is shared

    • isLocked

      boolean isLocked()
      Returns whether item is locked or not This is applicable for items which are shared explicitly or as inbox items It will return true when a item is locked by original assignee or any other user
      Returns:
      whether the inbox item is locked

    • getWorkflowMetadata

      Map getWorkflowMetadata()
      If the inbox item is created as part of a workflow, provides the associated workflow metadata. Returns null otherwise.
      Returns:
      The associated workflow metadata