Package com.adobe.granite.taskmanagement

Interface Task

All Superinterfaces:
InboxItem
@ProviderType public interface Task extends InboxItem
Task class describes a task instance.

  • Field Details

  • Method Details

    • getId

      String getId()
      Gets the ID of the task.
      Specified by:
      getId in interface InboxItem
      Returns:
      String containing the id of the task.

    • getUUId

      String getUUId()
      Gets the UUID for the task
      Returns:
      String containing the UUID of the Task

    • getParentId

      String getParentId()
      Returns the ID of the parent task.
      Returns:
      the ID of the parent task, or null if this is not a sub-task.

    • getName

      String getName()
      Gets the name of the task.
      Returns:
      String containing the name of the task.

    • setName

      void setName(String name)
      Sets the name of the task.
      Parameters:
      name - String containing the new name of the task.

    • getDescription

      String getDescription()
      Gets the description of the task.
      Returns:
      String containing the description of the task.

    • setDescription

      void setDescription(String description)
      Sets the description of the task.
      Parameters:
      description - String containing the new description of the task.

    • getStatus

      Status getStatus()
      Gets the current status of the task.
      Specified by:
      getStatus in interface InboxItem
      Returns:
      Status instance representing the current task status.

    • getCurrentAssignee

      String getCurrentAssignee()
      Gets the id of the owner of the task.
      Specified by:
      getCurrentAssignee in interface InboxItem
      Returns:
      String containing the id of the owner of the task.

    • setCurrentAssignee

      void setCurrentAssignee(String ownerId)
      Sets the id of the owner of the task.
      Parameters:
      ownerId - String containing the id of the owner of the task.

    • getTaskTypeName

      String getTaskTypeName()
      Gets the type of this task.
      Returns:
      String containing the name of the type of this task.

    • getTimeStarted

      Date getTimeStarted()
      Gets the time this task was created.
      Specified by:
      getTimeStarted in interface InboxItem
      Returns:
      Date containing the time this task was created.

    • getCreatedBy

      String getCreatedBy()
      Gets the ID for the user who created the task
      Returns:
      String containing the create user's ID

    • getLastModified

      Date getLastModified()
      Gets the time this task was last updated.
      Returns:
      Date containing the time this task was last updated.

    • getLastModifiedBy

      String getLastModifiedBy()
      Gets the ID for the user who last modified the task
      Returns:
      String containing the user's ID

    • getTimeEnded

      Date getTimeEnded()
      Gets the time this task was last completed.
      Specified by:
      getTimeEnded in interface InboxItem
      Returns:
      Date containing the time this task was completed.

    • getCompletedBy

      String getCompletedBy()
      Gets the ID for the user who completed the task
      Returns:
      String containing the complete user's ID

    • setProperty

      void setProperty(String name, Object value)
      Sets the property.
      Parameters:
      name - Name of the property to set.
      value - value of named property.

    • getProperty

      Object getProperty(String aPropertyName)
      Gets a property with the given name.
      Parameters:
      aPropertyName - Name of the property to retrieve.
      Returns:
      value of the specified property.

    • getPropertyNames

      Iterator<String> getPropertyNames()
      Gets an iterator of the property names for this task.
      Returns:
      an task property name iterator.

    • setInstructions

      void setInstructions(String aInstructions)
      Sets the instructions for this task.
      Parameters:
      aInstructions - String containing the new instructions for this task.

    • getInstructions

      String getInstructions()
      Gets the instructions for this task.
      Returns:
      String containing the instructions for this task.

    • getActions

      List<TaskAction> getActions()
      returns the list of action objects for this task.
      Returns:
      list of action objects

    • setActions

      void setActions(List<TaskAction> aListOfActions)
      sets the list of action objects for this task.
      Parameters:
      aListOfActions - list of action objects

    • getSelectedAction

      TaskAction getSelectedAction()
      gets the selected action used to complete the task.
      Returns:
      action TaskAction represented the action used to compete the task

    • getSubTasks

      List<Task> getSubTasks()
      Returns the list of subtasks for this task
      Returns:
      the list of subtasks

    • isSubTaskInfoLoaded

      boolean isSubTaskInfoLoaded()
      Indicates if this task object is fully populated with sub task information. For performance reasons some task objects may not be fully populated with sub task data.
      Returns:
      true if the sub tasks are loaded in this task object

    • hasSubTasks

      boolean hasSubTasks()
      Returns whether or not there are sub-tasks under this task. Task instances from the server (ie: it does not depend on sub-tasks being actually loaded)
      Returns:
      true if this task has sub-tasks, false otherwise

    • getContentPath

      String getContentPath()
      Returns a content path this task is associated with.
      Specified by:
      getContentPath in interface InboxItem
      Returns:
      the associated content path

    • setContentPath

      void setContentPath(String contentPath)
      Sets a content path that this task is associated with.
      Parameters:
      contentPath - the new content path for this task

    • setDueTime

      void setDueTime(Date dueTime)
      Sets the due time of this task.
      Parameters:
      dueTime - the new due time of this task

    • setProgressBeginTime

      void setProgressBeginTime(Date progressBeginTime)
      Sets the progress begin time for this task.
      Parameters:
      progressBeginTime - the time for when progress should start on this task.

    • setPriority

      void setPriority(InboxItem.Priority priority)
      Sets the priority for this task.
      Parameters:
      priority - the priority of this task.