|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workflow.CmsTask
Describes an OpenCms task.
Field Summary | |
static java.lang.String |
NAME_CONSTRAINTS
The name constraints when generating new tasks. |
Constructor Summary | |
CmsTask()
Creates a new CmsTask object with default values for all members. |
|
CmsTask(int id,
java.lang.String name,
int state,
int taskType,
int root,
int parent,
CmsUUID initiatorUserId,
CmsUUID roleId,
CmsUUID agentUserId,
CmsUUID originalUserId,
java.sql.Timestamp startTime,
java.sql.Timestamp wakeupTime,
java.sql.Timestamp timeOut,
java.sql.Timestamp endTime,
int percentage,
java.lang.String permission,
int priority,
int escalationType,
java.lang.String htmlLink,
int milestone,
int autofinish)
Creates a new CmsTask object. |
Method Summary | |
static void |
checkTaskName(java.lang.String name)
Checks if the provided task name is a valid task name, that is contains only valid characters. |
boolean |
equals(java.lang.Object obj)
|
CmsUUID |
getAgentUser()
Returns the agent user id of this task. |
int |
getAutoFinish()
Returns the autofinish flag of this task. |
java.sql.Timestamp |
getEndTime()
Returns the endtime of this task. |
int |
getEscalationType()
Returns the escalation type of this task. |
java.lang.String |
getHtmlLink()
Returns the html link of this task. |
int |
getId()
Returns the id of this task. |
CmsUUID |
getInitiatorUser()
Returns the initiator user id of this task. |
int |
getMilestone()
Returns the milestone value of this task. |
java.lang.String |
getName()
Returns the name of this task. |
CmsUUID |
getOriginalUser()
Returns the original agent user id of this task. |
int |
getParent()
Returns the parent id of this task. |
int |
getPercentage()
Returns the percentage of this task. |
java.lang.String |
getPermission()
Returns the permission of this task. |
int |
getPriority()
Returns the priority of this task. |
CmsUUID |
getRole()
Returns the role group id of this task. |
int |
getRoot()
Returns the root id of this task. |
java.sql.Timestamp |
getStartTime()
Returns the starttime of this task. |
int |
getState()
Returns the state of this task. |
java.lang.String |
getStateString()
Returns the state of this task as String. |
int |
getTaskType()
Returns the type of this task. |
java.sql.Timestamp |
getTimeOut()
Returns the timeout date of this task. |
java.sql.Timestamp |
getWakeupTime()
Returns the wakeup time of this task. |
int |
hashCode()
|
void |
setAgentUser(CmsUUID agentUserId)
Sets the agent user id for this task. |
void |
setInitiatorUser(CmsUUID initiatorUserId)
Sets the initiator user id for this task. |
void |
setMilestone(int milestone)
Sets the milestone value of this task. |
void |
setName(java.lang.String taskname)
Sets the name of this task. |
void |
setOriginalUser(CmsUUID originalUserId)
Sets the original user id of this task. |
void |
setParent(int parent)
Sets the parent id of this task. |
void |
setPercentage(int percentage)
Sets the percentage for this task. |
void |
setPriority(int priority)
Sets the priority for this task. |
void |
setRole(CmsUUID roleId)
Sets the role id for this task. |
void |
setRoot(int root)
Sets the root value for this task. |
void |
setStartTime(java.sql.Timestamp starttime)
Sets the start time of this task. |
void |
setState(int state)
Sets the state of this task. |
void |
setTaskType(int tasktype)
Sets the type of this task. |
void |
setTimeOut(java.sql.Timestamp timeout)
Sets the timeout value for this task. |
void |
setWakeupTime(java.sql.Timestamp wakeuptime)
Sets the wakeup time for this task. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String NAME_CONSTRAINTS
Constructor Detail |
public CmsTask()
public CmsTask(int id, java.lang.String name, int state, int taskType, int root, int parent, CmsUUID initiatorUserId, CmsUUID roleId, CmsUUID agentUserId, CmsUUID originalUserId, java.sql.Timestamp startTime, java.sql.Timestamp wakeupTime, java.sql.Timestamp timeOut, java.sql.Timestamp endTime, int percentage, java.lang.String permission, int priority, int escalationType, java.lang.String htmlLink, int milestone, int autofinish)
id
- the id of this taskname
- the name of this taskstate
- state of this tasktaskType
- type of this taskroot
- the id of the task which is the root task of this taskparent
- the id of the task which is the parent of this taskinitiatorUserId
- the id of the user who initiated this taskroleId
- the id of the role which is set for this taskagentUserId
- the id of the user who is the agent of this taskoriginalUserId
- the id of the user who was the original agentstartTime
- timestamp when this task has been startedwakeupTime
- timestamp when this task has to be activatedtimeOut
- timestamp when this task has to be completedendTime
- timestamp when the task has been endedpercentage
- percentage value of this taskpermission
- permission flag of this taskpriority
- priority of this taskescalationType
- escalation type of this taskhtmlLink
- link to the html page which handles this taskmilestone
- the id of the milstone to which this task belongsautofinish
- the auto finish value of this taskMethod Detail |
public static void checkTaskName(java.lang.String name) throws CmsIllegalArgumentException
A task name can only be composed of digits,
standard ASCII letters and the symbols defined in NAME_CONSTRAINTS
.
name
- the task name to check
CmsIllegalArgumentException
- if the given task name is not validpublic boolean equals(java.lang.Object obj)
Object.equals(java.lang.Object)
public CmsUUID getAgentUser()
public int getAutoFinish()
public java.sql.Timestamp getEndTime()
public int getEscalationType()
public java.lang.String getHtmlLink()
public int getId()
public CmsUUID getInitiatorUser()
public int getMilestone()
public java.lang.String getName()
public CmsUUID getOriginalUser()
public int getParent()
public int getPercentage()
public java.lang.String getPermission()
public int getPriority()
public CmsUUID getRole()
public int getRoot()
public java.sql.Timestamp getStartTime()
public int getState()
public java.lang.String getStateString()
public int getTaskType()
public java.sql.Timestamp getTimeOut()
public java.sql.Timestamp getWakeupTime()
public int hashCode()
Object.hashCode()
public void setAgentUser(CmsUUID agentUserId)
agentUserId
- the agent user id for this taskpublic void setInitiatorUser(CmsUUID initiatorUserId)
initiatorUserId
- the initiator user id for this taskpublic void setMilestone(int milestone)
milestone
- the milestone value of this taskpublic void setName(java.lang.String taskname)
taskname
- the name of this taskpublic void setOriginalUser(CmsUUID originalUserId)
originalUserId
- the original user id of this taskpublic void setParent(int parent)
parent
- the parent id of this taskpublic void setPercentage(int percentage)
percentage
- the percentage for this taskpublic void setPriority(int priority)
priority
- the priority for this taskpublic void setRole(CmsUUID roleId)
roleId
- the role id for this taskpublic void setRoot(int root)
root
- the root value for this taskpublic void setStartTime(java.sql.Timestamp starttime)
starttime
- the start time of this taskpublic void setState(int state)
state
- the state of this taskpublic void setTaskType(int tasktype)
tasktype
- the type of this taskpublic void setTimeOut(java.sql.Timestamp timeout)
timeout
- the timeout value for this taskpublic void setWakeupTime(java.sql.Timestamp wakeuptime)
wakeuptime
- the wakeup time for this taskpublic java.lang.String toString()
Object.toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |