Class ScheduleSummary

java.lang.Object
com.appiancorp.suiteapi.process.ScheduleSummary
All Implemented Interfaces:
Serializable

public class ScheduleSummary extends Object implements Serializable
Holds a high-level summary of the schedule which could be on a node or a pending node object if there is recurrence and spawning for that node
See Also:
  • Field Details

    • TASK_STATUS_SCHEDULED_SINGLE

      public static final Integer TASK_STATUS_SCHEDULED_SINGLE
      Constant for node having a schedule that once triggered will start a single task
    • TASK_STATUS_SCHEDULED_MULTIPLE

      public static final Integer TASK_STATUS_SCHEDULED_MULTIPLE
      Constant for node having a schedule that once triggered will start multiple tasks
    • SCHEDULE_TYPE_STARTED

      public static final Integer SCHEDULE_TYPE_STARTED
      Constant for the schedule already lapsed.
    • SCHEDULE_TYPE_PENDING_SINGLE

      public static final Integer SCHEDULE_TYPE_PENDING_SINGLE
      Constant for the schedule that is not lapsed, and when triggered will start a single task
    • SCHEDULE_TYPE_PENDING_MULTIPLE

      public static final Integer SCHEDULE_TYPE_PENDING_MULTIPLE
      Constant for the schedule that is not lapsed, and when triggered will start multiple tasks
    • SORT_BY_TEMPLATE_ID

      public static final Integer SORT_BY_TEMPLATE_ID
    • SORT_BY_TYPE

      public static final Integer SORT_BY_TYPE
    • SORT_BY_ID

      public static final Integer SORT_BY_ID
    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
    • SORT_BY_STATUS

      public static final Integer SORT_BY_STATUS
    • SORT_BY_OWNERS

      public static final Integer SORT_BY_OWNERS
    • SORT_BY_SCHEDULED_TIME

      public static final Integer SORT_BY_SCHEDULED_TIME
    • SORT_BY_ASSIGNED_TIME

      public static final Integer SORT_BY_ASSIGNED_TIME
    • SORT_BY_PRIORITY

      public static final Integer SORT_BY_PRIORITY
  • Constructor Details

    • ScheduleSummary

      public ScheduleSummary()
  • Method Details

    • getAssignedTime

      public Timestamp getAssignedTime()
      Returns:
      time at which the node was assigned
    • setAssignedTime

      public void setAssignedTime(Timestamp time_)
    • getName

      public String getName()
      Returns:
      the name of the task or the node if the task is pending.
    • setName

      public void setName(String name_)
    • getId

      public Long getId()
      Returns:
      the id of the task, or the pending task.
    • setId

      public void setId(Long id_)
    • getOwners

      public String[] getOwners()
      Returns:
      the usernames of those who have accepted the task or empty array if no one has taken ownership
    • setOwners

      public void setOwners(String[] owners_)
    • getPriority

      public Priority getPriority()
      Returns:
      the priority of the task or null if task is pending
    • setPriority

      public void setPriority(Priority priority_)
    • getScheduledTime

      public Timestamp getScheduledTime()
      Returns:
      the next scheduled time or null if there is no schedule or the schedule has lapsed
    • setScheduledTime

      public void setScheduledTime(Timestamp time_)
    • getStatus

      public Integer getStatus()
      Returns:
      the status of the task or pending task, and will be one of the
    • setStatus

      public void setStatus(Integer status_)
    • getTemplateId

      public Long getTemplateId()
      Returns:
      the id of the underlying node template
    • setTemplateId

      public void setTemplateId(Long id_)
    • getType

      public Integer getType()
      Returns:
      the type of the task, which can be one
    • setType

      public void setType(Integer type_)