com.appiancorp.suiteapi.process

Class ScheduleSummary

java.lang.Object

com.appiancorp.suiteapi.process.ScheduleSummary

All Implemented Interfaces:

java.io.Serializable

public class ScheduleSummary
extends java.lang.Object
implements java.io.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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SCHEDULE_TYPE_PENDING_MULTIPLE Constant for the schedule that is not lapsed, and when triggered will start multiple tasks
static java.lang.Integer	SCHEDULE_TYPE_PENDING_SINGLE Constant for the schedule that is not lapsed, and when triggered will start a single task
static java.lang.Integer	SCHEDULE_TYPE_STARTED Constant for the schedule already lapsed.
static java.lang.Integer	SORT_BY_ASSIGNED_TIME
static java.lang.Integer	SORT_BY_ID
static java.lang.Integer	SORT_BY_NAME
static java.lang.Integer	SORT_BY_OWNERS
static java.lang.Integer	SORT_BY_PRIORITY
static java.lang.Integer	SORT_BY_SCHEDULED_TIME
static java.lang.Integer	SORT_BY_STATUS
static java.lang.Integer	SORT_BY_TEMPLATE_ID
static java.lang.Integer	SORT_BY_TYPE
static java.lang.Integer	TASK_STATUS_SCHEDULED_MULTIPLE Constant for node having a schedule that once triggered will start multiple tasks
static java.lang.Integer	TASK_STATUS_SCHEDULED_SINGLE Constant for node having a schedule that once triggered will start a single task

Constructor Summary

Constructors

Constructor and Description
ScheduleSummary()

Method Summary

Modifier and Type	Method and Description
java.sql.Timestamp	getAssignedTime()
java.lang.Long	getId()
java.lang.String	getName()
java.lang.String[]	getOwners()
Priority	getPriority()
java.sql.Timestamp	getScheduledTime()
java.lang.Integer	getStatus()
java.lang.Long	getTemplateId()
java.lang.Integer	getType()
void	setAssignedTime(java.sql.Timestamp time_)
void	setId(java.lang.Long id_)
void	setName(java.lang.String name_)
void	setOwners(java.lang.String[] owners_)
void	setPriority(Priority priority_)
void	setScheduledTime(java.sql.Timestamp time_)
void	setStatus(java.lang.Integer status_)
void	setTemplateId(java.lang.Long id_)
void	setType(java.lang.Integer type_)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TASK_STATUS_SCHEDULED_SINGLE

public static final java.lang.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 java.lang.Integer TASK_STATUS_SCHEDULED_MULTIPLE

Constant for node having a schedule that once triggered will start multiple tasks

SCHEDULE_TYPE_STARTED

public static final java.lang.Integer SCHEDULE_TYPE_STARTED

Constant for the schedule already lapsed.

SCHEDULE_TYPE_PENDING_SINGLE

public static final java.lang.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 java.lang.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 java.lang.Integer SORT_BY_TEMPLATE_ID

SORT_BY_TYPE

public static final java.lang.Integer SORT_BY_TYPE

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

SORT_BY_STATUS

public static final java.lang.Integer SORT_BY_STATUS

SORT_BY_OWNERS

public static final java.lang.Integer SORT_BY_OWNERS

SORT_BY_SCHEDULED_TIME

public static final java.lang.Integer SORT_BY_SCHEDULED_TIME

SORT_BY_ASSIGNED_TIME

public static final java.lang.Integer SORT_BY_ASSIGNED_TIME

SORT_BY_PRIORITY

public static final java.lang.Integer SORT_BY_PRIORITY

Constructor Detail

ScheduleSummary

public ScheduleSummary()

Method Detail

getAssignedTime

public java.sql.Timestamp getAssignedTime()

Returns:

time at which the node was assigned

setAssignedTime

public void setAssignedTime(java.sql.Timestamp time_)

getName

public java.lang.String getName()

Returns:

the name of the task or the node if the task is pending.

setName

public void setName(java.lang.String name_)

getId

public java.lang.Long getId()

Returns:

the id of the task, or the pending task.

setId

public void setId(java.lang.Long id_)

getOwners

public java.lang.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(java.lang.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 java.sql.Timestamp getScheduledTime()

Returns:

the next scheduled time or null if there is no schedule or the schedule has lapsed

setScheduledTime

public void setScheduledTime(java.sql.Timestamp time_)

getStatus

public java.lang.Integer getStatus()

Returns:

the status of the task or pending task, and will be one of the

setStatus

public void setStatus(java.lang.Integer status_)

getTemplateId

public java.lang.Long getTemplateId()

Returns:

the id of the underlying node template

setTemplateId

public void setTemplateId(java.lang.Long id_)

getType

public java.lang.Integer getType()

Returns:

the type of the task, which can be one

setType

public void setType(java.lang.Integer type_)