Package com.adobe.cq.inbox.ui

Interface InboxItem

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAssociatedProjectDetailsUrl()
      Returns the task project URL if task is related to a project.
      java.util.Map<java.lang.String,​java.lang.String> getCurrentAssigneeInfo()
      Returns a Map containing information about the current assignee.
      java.lang.String getDescription()
      Returns the item description.
      java.lang.String getDetailsUrl()
      Returns the task details URL.
      java.util.Date getDueDate()
      Returns the task due date.
      java.lang.String getDueDateColor()
      Returns the due date color name.
      java.lang.String getPath()
      Returns the item path.
      java.lang.String getPayloadLink()
      Returns the payload link.
      java.lang.String getPayloadPath()
      Returns the payload path in the repository.
      java.lang.String getPayloadThumbnail()
      Returns the payload thumbnail path.
      java.lang.String getPriority()
      Returns the task priority.
      java.lang.String getPriorityIcon()
      Returns the task priority icon identifier.
      java.lang.String getPriorityStyle()
      Returns the task priority style class name.
      java.lang.String getProjectId()
      Returns the task project identifier if task is related to a project.
      java.lang.String getProjectTitle()
      Returns the task project title if task is related to a project.
      java.util.Set<java.lang.String> getQuickactionsRel()
      Returns the quickaction relation identifiers.
      java.lang.String getResourceType()
      Returns the item resource type.
      java.util.Date getStartDate()
      Returns the task start date.
      java.lang.String getStatus()
      Returns the task status.
      java.lang.String getStatusIcon()
      Returns the task status icon.
      java.lang.String getStatusType()
      Returns the task status type.
      java.lang.String getTaskActions()
      Returns the task actions as serialized JSONArray in the following form.
      java.lang.String getThumbnail()
      Returns the thumbnail path.
      java.lang.String getTitle()
      Returns the item title.
      java.lang.String getWorkflowInitiator()
      Returns the workflow initiator identifier if task is related to a workflow.
      java.util.Map getWorkflowMetadata()
      If the inbox item is created as part of a workflow, provides the associated workflow metadata.
      java.lang.String getWorkflowTitle()
      Returns the workflow title if task is related to a workflow.
      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
      boolean isPayloadFolder()
      Indicates if referenced payload is of type folder.
      boolean isShared()
      Returns whether this inbox item is shared or not.

    • Method Detail

      • getTitle

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

      • getDescription

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

      • getPath

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

      • getResourceType

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

      • getCurrentAssigneeInfo

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

      • getPayloadLink

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

      • getPayloadPath

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

      • getPayloadThumbnail

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

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

      • getPriority

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

      • getPriorityIcon

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

      • getPriorityStyle

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

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

      • getStatusIcon

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

      • getStatusType

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

      • getDetailsUrl

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

      • getProjectId

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

      • getProjectTitle

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

      • getAssociatedProjectDetailsUrl

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

      • getWorkflowTitle

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

      • getWorkflowInitiator

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

      • getStartDate

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

      • getDueDate

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

      • getDueDateColor

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

      • getQuickactionsRel

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

      • getTaskActions

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

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