Modifier and Type | Interface and Description |
---|---|
static class |
Task.EditorMode
Task editor mode
|
static class |
Task.ErrorCode
Error code for task verify.
|
static class |
Task.Mode
Task context mode
|
static class |
Task.Priority
Task priority
|
static class |
Task.VerifyError
This class holds the error code and a localized error message of verify errors.
|
Modifier and Type | Field and Description |
---|---|
static String |
ERROR_ACTIVITY_ID
String for the error attribute of the activity ID.
|
static String |
ERROR_COMMENT
String for the error attribute of a comment.
|
static String |
ERROR_INFO
String for the error attribute of the throwable info.
|
static String |
ERROR_THROWABLE
String for the error attribute of the throwable.
|
static String |
ERROR_USER_LOGIN
String for the error attribute of the user login.
|
static String |
ERROR_USER_NAME
String for the error attribute of the user name.
|
Modifier and Type | Method and Description |
---|---|
void |
closeTask()
Close this task
|
State |
doTransition(WorkflowContext context,
Transition transition)
Perform transition execution on this task.
|
Date |
getCreationDate()
Get task creation date
|
User |
getCreator()
Ger task creator
|
Map<Object,Object> |
getCustomAttributes()
Get task session attributes.
|
Data |
getCustomData()
Deprecated.
since 5.2.19, use
getCustomFormData() . |
FormData |
getCustomFormData()
Get this task's custom form data.
|
Date |
getDueDate()
Get task due date
|
Task.EditorMode |
getEditorMode()
Get task editor mode
|
List<Principal> |
getEditors()
Get task allowed editors list
|
TaskErrorInfo |
getErrorInfo()
Return error info object or null if the error state has not been reached.
|
List<TaskState> |
getHistory()
Get task state history
|
long |
getId()
Get task id
|
Task.Mode |
getMode()
Get task mode
|
Task.Priority |
getPriority()
Get task priority
|
Project |
getProject()
Get project
|
TaskState |
getTaskState()
Get current task state
|
Workflow |
getWorkflow()
Get workflow model
|
Workflowable |
getWorkflowable()
Return
Workflowable . |
void |
gotoErrorState(WorkflowContext context,
Activity activity,
String comment,
Throwable throwable)
Goto model error state.
|
boolean |
isFinished()
Is task finished
|
boolean |
isTimeoutMailSend()
Was task timeout mail send
|
void |
setCustomData(Data customData)
Deprecated.
since 5.2.19, use
setCustomFormData(FormData) . |
void |
setCustomFormData(FormData customFormData)
Set this task's custom form data.
|
void |
setDueDate(Date dueDate)
Set task due date
|
void |
setEditors(List<Principal> editorUsers)
Set allowed editors
|
void |
setPriority(Task.Priority priority)
Set task priority
|
List<Task.VerifyError> |
verify()
Verify state of this task object.
|
static final String ERROR_USER_LOGIN
static final String ERROR_USER_NAME
static final String ERROR_COMMENT
static final String ERROR_THROWABLE
static final String ERROR_INFO
static final String ERROR_ACTIVITY_ID
long getId()
Project getProject()
Task.Mode getMode()
Date getCreationDate()
boolean isFinished()
User getCreator()
@Nullable Workflowable getWorkflowable()
Workflowable
. The returned Workflowable
will be a StoreElement
in Task.Mode.STORE_ELEMENT
mode, a ContentWorkflowable
in Task.Mode.ENTITY
mode or null in Task.Mode.NO_CONTEXT
mode.TaskState getTaskState()
State doTransition(@NotNull WorkflowContext context, @NotNull Transition transition) throws LockException, ElementDeletedException
LockException
ElementDeletedException
void gotoErrorState(@NotNull WorkflowContext context, @Nullable Activity activity, @Nullable String comment, @Nullable Throwable throwable)
IllegalStateException
- thrown if no error state is defined in modelTaskErrorInfo getErrorInfo()
Workflow getWorkflow()
Task.Priority getPriority()
void setPriority(Task.Priority priority)
boolean isTimeoutMailSend()
Date getDueDate()
void setDueDate(Date dueDate)
@Deprecated Data getCustomData()
getCustomFormData()
.@Deprecated void setCustomData(Data customData)
setCustomFormData(FormData)
.@Nullable FormData getCustomFormData()
null
.void setCustomFormData(@Nullable FormData customFormData)
customFormData
- The form data to set, may be null
.Map<Object,Object> getCustomAttributes()
IllegalArgumentException
is thrown if a key or value with serialisation problems is added to the map.Task.EditorMode getEditorMode()
void closeTask()
List<Task.VerifyError> verify()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210