com.appiancorp.suiteapi.process

Class ProcessSummary

java.lang.Object

com.appiancorp.suiteapi.common.Identity

com.appiancorp.suiteapi.process.ProcessProperties

com.appiancorp.suiteapi.process.ProcessSummary

All Implemented Interfaces:

LocalId, java.io.Serializable

Direct Known Subclasses:

ProcessDetails

public class ProcessSummary
extends ProcessProperties

Holds high-level, summary metadata about a process.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SORT_BY_PROCESS_COMPLETED_TASK_COUNT Constant for sorting by the number of tasks in the process with "Completed" status
static java.lang.Integer	SORT_BY_PROCESS_CURRENT_TASK_COUNT Constant for sorting by the number of tasks in the process with "Current" status
static java.lang.Integer	SORT_BY_PROCESS_ELAPSED_MILLISECONDS Constant for sorting by the number of milliseconds that have elapsed since the process started
static java.lang.Integer	SORT_BY_PROCESS_END_TIME Constant for sorting by the process end time
static java.lang.Integer	SORT_BY_PROCESS_ID Constant for sorting by the process id
static java.lang.Integer	SORT_BY_PROCESS_INITIATOR Constant for sorting by the username of the process initiator
static java.lang.Integer	SORT_BY_PROCESS_MODEL_NAME Constant for sorting by the process model name
static java.lang.Integer	SORT_BY_PROCESS_NAME Constant for sorting by process name
static java.lang.Integer	SORT_BY_PROCESS_PARENT_NAME Constant for sorting by the parent process name
static java.lang.Integer	SORT_BY_PROCESS_PRIORITY Constant for sorting by the priority name
static java.lang.Integer	SORT_BY_PROCESS_PRIORITY_NAME Constant for sorting by the priority name
static java.lang.Integer	SORT_BY_PROCESS_START_TIME Constant for sorting by the start time
static java.lang.Integer	SORT_BY_PROCESS_STATUS_NAME Constant for sorting by the status name
static int	STATE_ACTIVE Constant indicating a running process.
static int	STATE_CANCELLED Constant indicating a cancelled process.
static int	STATE_COMPLETED Constant indicating a completed process.
static int	STATE_PAUSED Constant indicating a paused process.
static int	STATE_PAUSED_BY_EXCEPTION Constant indicating a paused-by-exception process.

Constructor Summary

Constructors

Constructor and Description
ProcessSummary()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getCompletedTaskCount() Retrieves the number of completed tasks in the process
java.lang.Integer	getCurrentTaskCount() Retrieves the number of tasks that are active
java.lang.Long	getDashboardId()
java.lang.Long	getElapsedMilliseconds() Retrieves the number of milliseconds since the process has started
java.sql.Timestamp	getEndTime() Returns the time at which the process ended.
ProcessException	getException() Returns the ProcessException that occurred in the process execution.
boolean	getFavorite()
boolean	getMutablePriority() Returns true if the Priority of the process can be changed else false
java.lang.Long	getParentId() gets the id of the parent process if one exists
java.lang.String	getParentName() Gets the parent process name if one exists
ProcessPermissions	getPermissions() Retrieves the permissions of the user for the process.
java.lang.Long	getProcessModelId() Retrieves the id of the process model
java.lang.String	getProcessModelName() Retrieves the name of the process model
java.lang.String	getProcessModelVersion() Retrieves the version of the Process Model
java.sql.Timestamp	getStartTime() Retrieves the time at which the process started
int	getStatus() Retrieves the status of the process.
java.lang.String	getStatusName() Retrieves the string representation of the current status of the process.
void	setCompletedTaskCount(java.lang.Integer taskCount_) Sets the number of completed tasks in the process
void	setCurrentTaskCount(java.lang.Integer taskCount_) Sets the number of active tasks
void	setDashboardId(java.lang.Long dashboardId_)
void	setElapsedMilliseconds(java.lang.Long milliseconds_) Sets the number of milliseconds since the process has started
void	setEndTime(java.sql.Timestamp time_) Sets the time at which the process ended.
void	setException(ProcessException exception_) Sets the ProcessException that occurred in the process execution.
void	setFavorite(boolean favorite_)
void	setMutablePriority(boolean mutablePriority_) Sets whether or not the priority of this process can be changed
void	setParentId(java.lang.Long parentId_) Sets the id of the parent process
void	setParentName(java.lang.String parentName_) Sets the name of the process' parent
void	setPermissions(ProcessPermissions permissions_) Sets the permissions of the user for the process
void	setProcessModelId(java.lang.Long modelId_) Sets the id of the process model
void	setProcessModelName(java.lang.String modelName_) Sets the name of the process model
void	setProcessModelVersion(java.lang.String version_) Sets the version of the Process Model
void	setStartTime(java.sql.Timestamp time_) Sets the time at which the process started
void	setStatus(int status_) Sets status of the process.
void	setStatusName(java.lang.String name_) Sets the string representation of the current status of the process.
void	toXML(java.lang.StringBuilder buffer_)

Methods inherited from class com.appiancorp.suiteapi.process.ProcessProperties

getInitiator, getPriority, setInitiator, setPriority, toString

Methods inherited from class com.appiancorp.suiteapi.common.Identity

equals, getId, getName, getUuid, hashCode, setId, setName, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SORT_BY_PROCESS_NAME

public static final java.lang.Integer SORT_BY_PROCESS_NAME

Constant for sorting by process name

SORT_BY_PROCESS_INITIATOR

public static final java.lang.Integer SORT_BY_PROCESS_INITIATOR

Constant for sorting by the username of the process initiator

SORT_BY_PROCESS_STATUS_NAME

public static final java.lang.Integer SORT_BY_PROCESS_STATUS_NAME

Constant for sorting by the status name

SORT_BY_PROCESS_PRIORITY_NAME

public static final java.lang.Integer SORT_BY_PROCESS_PRIORITY_NAME

Constant for sorting by the priority name

SORT_BY_PROCESS_MODEL_NAME

public static final java.lang.Integer SORT_BY_PROCESS_MODEL_NAME

Constant for sorting by the process model name

SORT_BY_PROCESS_START_TIME

public static final java.lang.Integer SORT_BY_PROCESS_START_TIME

Constant for sorting by the start time

SORT_BY_PROCESS_END_TIME

public static final java.lang.Integer SORT_BY_PROCESS_END_TIME

Constant for sorting by the process end time

SORT_BY_PROCESS_ELAPSED_MILLISECONDS

public static final java.lang.Integer SORT_BY_PROCESS_ELAPSED_MILLISECONDS

Constant for sorting by the number of milliseconds that have elapsed since the process started

SORT_BY_PROCESS_CURRENT_TASK_COUNT

public static final java.lang.Integer SORT_BY_PROCESS_CURRENT_TASK_COUNT

Constant for sorting by the number of tasks in the process with "Current" status

SORT_BY_PROCESS_COMPLETED_TASK_COUNT

public static final java.lang.Integer SORT_BY_PROCESS_COMPLETED_TASK_COUNT

Constant for sorting by the number of tasks in the process with "Completed" status

SORT_BY_PROCESS_ID

public static final java.lang.Integer SORT_BY_PROCESS_ID

Constant for sorting by the process id

SORT_BY_PROCESS_PARENT_NAME

public static final java.lang.Integer SORT_BY_PROCESS_PARENT_NAME

Constant for sorting by the parent process name

SORT_BY_PROCESS_PRIORITY

public static final java.lang.Integer SORT_BY_PROCESS_PRIORITY

Constant for sorting by the priority name

STATE_ACTIVE

public static final int STATE_ACTIVE

Constant indicating a running process. For use with ProcessExecutionService.getProcessesForGroup.

See Also:

Constant Field Values

STATE_COMPLETED

public static final int STATE_COMPLETED

Constant indicating a completed process. For use with ProcessExecutionService.getProcessesForGroup.

See Also:

Constant Field Values

STATE_PAUSED

public static final int STATE_PAUSED

Constant indicating a paused process. For use with ProcessExecutionService.getProcessesForGroup.

See Also:

Constant Field Values

STATE_CANCELLED

public static final int STATE_CANCELLED

Constant indicating a cancelled process. For use with ProcessExecutionService.getProcessesForGroup.

See Also:

Constant Field Values

STATE_PAUSED_BY_EXCEPTION

public static final int STATE_PAUSED_BY_EXCEPTION

Constant indicating a paused-by-exception process.

See Also:

Constant Field Values

Constructor Detail

ProcessSummary

public ProcessSummary()

Method Detail

getFavorite

public boolean getFavorite()

setFavorite

public void setFavorite(boolean favorite_)

getException

public ProcessException getException()

Returns the ProcessException that occurred in the process execution.

Returns:

Returns the exception.

setException

public void setException(ProcessException exception_)

Sets the ProcessException that occurred in the process execution.

Parameters:

exception_ - process exception

getProcessModelVersion

public java.lang.String getProcessModelVersion()

Retrieves the version of the Process Model

Returns:

the process mode version of this process

setProcessModelVersion

public void setProcessModelVersion(java.lang.String version_)

Sets the version of the Process Model

Parameters:

version_ - the version for Process Model

getMutablePriority

public boolean getMutablePriority()

Returns true if the Priority of the process can be changed else false

Returns:

whether or not the priority of this process can be changed

setMutablePriority

public void setMutablePriority(boolean mutablePriority_)

Sets whether or not the priority of this process can be changed

Parameters:

mutablePriority_ - true if the priority of the process can be changed

getParentId

public java.lang.Long getParentId()

gets the id of the parent process if one exists

Returns:

the id of the parent process

setParentId

public void setParentId(java.lang.Long parentId_)

Sets the id of the parent process

Parameters:

parentId_ - the id of the parent to set

getParentName

public java.lang.String getParentName()

Gets the parent process name if one exists

Returns:

the parent process' name

setParentName

public void setParentName(java.lang.String parentName_)

Sets the name of the process' parent

Parameters:

parentName_ - the name to set for the parent process

getCompletedTaskCount

public java.lang.Integer getCompletedTaskCount()

Retrieves the number of completed tasks in the process

Returns:

number of completed Tasks.

setCompletedTaskCount

public void setCompletedTaskCount(java.lang.Integer taskCount_)

Sets the number of completed tasks in the process

Parameters:

taskCount_ - number of completed tasks.

getCurrentTaskCount

public java.lang.Integer getCurrentTaskCount()

Retrieves the number of tasks that are active

Returns:

number of active tasks

setCurrentTaskCount

public void setCurrentTaskCount(java.lang.Integer taskCount_)

Sets the number of active tasks

Parameters:

taskCount_ - number of active tasks.

getElapsedMilliseconds

public java.lang.Long getElapsedMilliseconds()

Retrieves the number of milliseconds since the process has started

Returns:

number of milliseconds.

setElapsedMilliseconds

public void setElapsedMilliseconds(java.lang.Long milliseconds_)

Sets the number of milliseconds since the process has started

Parameters:

milliseconds_ - elapsed milliseconds

getEndTime

public java.sql.Timestamp getEndTime()

Returns the time at which the process ended. Null if the process is currently active.

Returns:

Returns the timestamp of the process end time.

setEndTime

public void setEndTime(java.sql.Timestamp time_)

Sets the time at which the process ended.

Parameters:

time_ - the end timestamp of the process.

getProcessModelId

public java.lang.Long getProcessModelId()

Retrieves the id of the process model

Returns:

process model id.

setProcessModelId

public void setProcessModelId(java.lang.Long modelId_)

Sets the id of the process model

Parameters:

modelId_ - id of process model to set.

getProcessModelName

public java.lang.String getProcessModelName()

Retrieves the name of the process model

Returns:

name of process model.

setProcessModelName

public void setProcessModelName(java.lang.String modelName_)

Sets the name of the process model

Parameters:

modelName_ - name of the process model to set.

getStartTime

public java.sql.Timestamp getStartTime()

Retrieves the time at which the process started

Returns:

timestamp of the process start time.

setStartTime

public void setStartTime(java.sql.Timestamp time_)

Sets the time at which the process started

Parameters:

time_ - timestamp of the process start time.

getStatusName

public java.lang.String getStatusName()

Retrieves the string representation of the current status of the process.

Returns:

status.

setStatusName

public void setStatusName(java.lang.String name_)

Sets the string representation of the current status of the process.

Parameters:

name_ - status string of the process.

getStatus

public int getStatus()

Retrieves the status of the process. Should be one of the STATE_XXX constants.

Returns:

the status, as one of the STATE_XXX constants.

setStatus

public void setStatus(int status_)

Sets status of the process. Should be one of the STATE_XXX constants.

Parameters:

status_ - the status, as one of the STATE_XXX constants.

getPermissions

public ProcessPermissions getPermissions()

Retrieves the permissions of the user for the process. The user is the one under whos context the service instance was created.

Returns:

ProcessPermission of the user

setPermissions

public void setPermissions(ProcessPermissions permissions_)

Sets the permissions of the user for the process

Parameters:

permissions_ - ProcessPermissions of the user from the process

toXML

public void toXML(java.lang.StringBuilder buffer_)

getDashboardId

public java.lang.Long getDashboardId()

setDashboardId

public void setDashboardId(java.lang.Long dashboardId_)