public interface ITask extends INoteable, IAdditionalPropertyable, IPropertyValueSource<TaskProperty>
Modifier and Type | Method and Description |
---|---|
void |
destroy()
Destroys this task
|
ISecurityMember |
getActivator()
Gets the task activator.
|
String |
getActivatorName()
Gets the name of the task activator (see
ITask.getActivator() for more details). |
List<IUser> |
getActivatorUserCandidates()
Gets a list of all the users who can resume this task.
|
IApplication |
getApplication()
Gets the application the case belongs to
|
String |
getBusinessCreatorUser()
Gets the case business creator user.
|
Integer |
getBusinessMainContactId()
Gets the case business main contact identifier.
|
String |
getBusinessMainContactName()
Gets the case business main contact name.
|
Date |
getBusinessMilestoneTimestamp()
Gets the business milestone timestamp.
|
String |
getBusinessObjectCode()
Gets the case business object code.
|
BusinessDuration |
getBusinessRuntime()
Gets the
BusinessDuration between the creation (see ITask.getStartTimestamp() ) and the
completion (see ITask.getEndTimestamp() ) of this task. |
Date |
getBusinessStartTimestamp()
Gets the case business start timestamp.
|
ICase |
getCase()
Gets the case this task belongs to
|
Category |
getCategory()
|
String |
getCategoryPath()
Returns the category path of this
ITask . |
Number |
getCustomDecimalField1()
Gets the custom decimal field 1.
|
Number |
getCustomDecimalField2()
Gets the custom decimal field 2.
|
Number |
getCustomDecimalField3()
Gets the custom decimal field 3.
|
Number |
getCustomDecimalField4()
Gets the custom decimal field 4.
|
Number |
getCustomDecimalField5()
Gets the custom decimal field 5.
|
Date |
getCustomTimestampField1()
Gets the custom timestamp field 1.
|
Date |
getCustomTimestampField2()
Gets the custom timestamp field 2.
|
Date |
getCustomTimestampField3()
Gets the custom timestamp field 3.
|
Date |
getCustomTimestampField4()
Gets the custom timestamp field 4.
|
Date |
getCustomTimestampField5()
Gets the custom timestamp field 5.
|
String |
getCustomVarCharField1()
Gets the custom varchar field 1.
|
String |
getCustomVarCharField2()
Gets the custom varchar field 2.
|
String |
getCustomVarCharField3()
Gets the custom varchar field 3.
|
String |
getCustomVarCharField4()
Gets the custom varchar field 4.
|
String |
getCustomVarCharField5()
Gets the custom varchar field 5.
|
Date |
getDelayTimestamp()
Get the delay timestamp of the task.
|
String |
getDescription()
Get description of the task
|
String |
getDisplayDescriptionTemplate()
Gets the display description template of the task
|
String |
getDisplayNameTemplate()
Gets the display name template of the task
|
ITaskEnd |
getEnd()
Gets the task end this task has ended on.
|
CompositeObject |
getEndProcessData()
Gets the process data (in-object) at the end of the task-process or null, if task was not ended.
|
ITaskSwitchEvent |
getEndSwitchEvent()
Gets the task switch event on which this task has ended.
|
Date |
getEndTimestamp()
Gets the end timestamp of the task or null if task is not yet finished
|
ITask |
getExpiredCreatorTask()
Gets the task that created this task because it has expired.
|
BusinessDuration |
getExpiresInBusinessDuration()
Calculates the business time until the task expires
(
BusinessDuration between now and expiryTimestamp ). |
ISecurityMember |
getExpiryActivator()
Gets the task expiry activator.
|
String |
getExpiryActivatorName()
Gets the task activator.
|
WorkflowPriority |
getExpiryPriority()
Gets the expiry priority of the task
|
String |
getExpiryTaskStartElementPid()
Gets the pid of the start element where a task should be started if this task expires.
|
Date |
getExpiryTimestamp()
Gets the timestamp when this task expires.
|
String |
getFailReason()
Returns the fail reason when the task state is
TaskState.FAILED , TaskState.JOIN_FAILED or TaskState.UNASSIGNED
and this state was caused by a failure. |
String |
getFullRequestPath()
Get the full request path of the task inclusive application name and process model version name
|
long |
getId()
Gets the identifier of this task
|
IIntermediateEvent |
getIntermediateEvent()
Gets the intermediate event this task is waiting for or had been waited for
|
String |
getKindCode()
Deprecated.
use
category to categorize the case |
String |
getKindName()
Deprecated.
use
category to categorize the case |
String |
getName()
Get name of the task
|
Integer |
getNumberOfResumes()
Returns how many times the tasks has ben resumed by any user (task state changes to
TaskState.RESUMED ). |
ISecurityMember |
getOriginalActivator()
Gets the original task activator.
|
String |
getOriginalActivatorName()
Gets the original task activator.
|
WorkflowPriority |
getOriginalPriority()
Gets the original priority of the task
|
IPageArchive |
getPageArchive(long pageArchiveIdentifier)
Find a page archive with its identifier
|
List<IPageArchive> |
getPageArchives()
Gets all page archives associated with this tasks
|
WorkflowPriority |
getPriority()
Gets the priority of the task
|
String |
getProcessCategoryCode()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
String |
getProcessCategoryName()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
String |
getProcessCode()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
IProcessModel |
getProcessModel()
Gets the process model the case belongs to
|
IWorkflowProcessModelVersion |
getProcessModelVersion()
Gets the process model version the case was started in
|
String |
getProcessName()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
String |
getRequestPath()
Gets the request path of this task
|
ITaskStart |
getStart()
Gets the task start this task was started on
|
CompositeObject |
getStartProcessData()
Gets the process data (in-object) at the start of the task-process or null, if it is the initial task.
|
ITaskSwitchEvent |
getStartSwitchEvent()
Gets the task switch event this task was started.
|
Date |
getStartTimestamp()
Gets the start timestamp of the task
|
TaskState |
getState()
Gets the state of this task
|
String |
getSubTypeCode()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
String |
getSubTypeName()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
String |
getTypeCode()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
String |
getTypeName()
Deprecated.
use
category to categorize the case or ITask.getCategory() to categorize the task |
IWorkflowSession |
getWorkerSession()
Gets the worker session of this task.
|
IUser |
getWorkerUser()
Gets the user who has worked or is working on this task.
|
String |
getWorkerUserName()
Gets the name of the user who has worked or is working on this task.
|
IWorkflowContext |
getWorkflowContext()
Gets the workflow context this case belongs to
|
List<IWorkflowEvent> |
getWorkflowEvents()
Gets the workflow events of this task
|
Duration |
getWorkingTime()
Gets the
Duration during that any user has been working on this task.The working time is calculated from the time where the user starts working on this task till the task is completed (state changes from TaskState.CREATED or TaskState.RESUMED to TaskState.DONE or TaskState.JOINING ).When task gets parked or completed the elapsed time is saved. |
boolean |
isExpired()
Is this task expired?
|
boolean |
isExpiryTask()
Is this task a task that was created because an other task had expired?
|
boolean |
isPersistent()
Checks if a task is persistent.
|
ILocationService |
locations()
Gets the locations of the task.
|
void |
reset()
Resets this task to the task start.
|
void |
setActivator(ISecurityMember activator)
Sets the activator of the task.
|
void |
setBusinessCalendar(IBusinessCalendar calendar)
Defines the
IBusinessCalendar for this ITask . |
void |
setBusinessMilestoneTimestamp(Date businessMilestoneTimestamp)
Sets the business milestone timestamp.
|
void |
setCategoryPath(String categoryPath)
Sets the given String as category path of this
ITask . |
void |
setCustomDecimalField1(Number customDecimalField1)
Sets the custom decimal field 1.
|
void |
setCustomDecimalField2(Number customDecimalField2)
Sets the custom decimal field 2.
|
void |
setCustomDecimalField3(Number customDecimalField3)
Sets the custom decimal field 3.
|
void |
setCustomDecimalField4(Number customDecimalField4)
Sets the custom decimal field 4.
|
void |
setCustomDecimalField5(Number customDecimalField5)
Sets the custom decimal field 5.
|
void |
setCustomTimestampField1(Date customTimestampField1)
Sets the custom timestamp field 1.
|
void |
setCustomTimestampField2(Date customTimestampField2)
Sets the custom timestamp field 2.
|
void |
setCustomTimestampField3(Date customTimestampField3)
Sets the custom timestamp field 3.
|
void |
setCustomTimestampField4(Date customTimestampField4)
Sets the custom timestamp field 4.
|
void |
setCustomTimestampField5(Date customTimestampField5)
Sets the custom timestamp field 5.
|
void |
setCustomVarCharField1(String customVarCharField1)
Sets the custom varchar field 1.
|
void |
setCustomVarCharField2(String customVarCharField2)
Sets the custom varchar field 2.
|
void |
setCustomVarCharField3(String customVarCharField3)
Sets the custom varchar field 3.
|
void |
setCustomVarCharField4(String customVarCharField4)
Sets the custom varchar field 4.
|
void |
setCustomVarCharField5(String customVarCharField5)
Sets the custom varchar field 5.
|
void |
setDelayTimestamp(Date newDelayTimestamp)
Sets the delay timestamp of the task.
|
void |
setDescription(String description)
Sets the description of the task
|
void |
setExpiryActivator(ISecurityMember expiryActivator)
Sets the expiry activator of the task.
|
void |
setExpiryPriority(WorkflowPriority expiryPriority)
Sets the expiry priority of the task
|
void |
setExpiryTimestamp(Date newExpiryTimestamp)
Sets the expiry timestamp of the task.
|
void |
setKind(String kindCode,
String kindName)
Deprecated.
use
category to categorize the case |
void |
setName(String name)
Sets the name of the task
|
void |
setOriginalActivator(ISecurityMember activator)
Sets the original activator of the task
|
void |
setOriginalPriority(WorkflowPriority originalPriority)
Sets the original priority of the task
|
createNote, deleteNote, getNotes, hasNotes
getAdditionalProperty, getAdditionalPropertyNames, setAdditionalProperty
IApplication getApplication() throws PersistencyException
PersistencyException
- if persistency access failsIWorkflowContext getWorkflowContext() throws PersistencyException
PersistencyException
- if persistency access failsIProcessModel getProcessModel() throws PersistencyException
PersistencyException
- if persistency access failsIWorkflowProcessModelVersion getProcessModelVersion() throws PersistencyException
PersistencyException
- if persistency access failsICase getCase() throws PersistencyException
PersistencyException
- if persistency access failsITaskSwitchEvent getStartSwitchEvent() throws PersistencyException
PersistencyException
- if persistency access failsITaskStart getStart() throws PersistencyException
PersistencyException
- if persistency access failsITaskSwitchEvent getEndSwitchEvent() throws PersistencyException
PersistencyException
- if persistency access failsITaskEnd getEnd() throws PersistencyException
PersistencyException
- if persistency access failsITask getExpiredCreatorTask() throws PersistencyException
ITask.isExpiryTask()
.PersistencyException
- if persistency access failslong getId()
TaskState getState() throws PersistencyException
PersistencyException
- if persistency access failsString getFailReason()
TaskState.FAILED
, TaskState.JOIN_FAILED
or TaskState.UNASSIGNED
and this state was caused by a failure.WorkflowPriority getPriority() throws PersistencyException
PersistencyException
- if persistency access failsWorkflowPriority getOriginalPriority() throws PersistencyException
PersistencyException
- if persistency access failsWorkflowPriority getExpiryPriority() throws PersistencyException
PersistencyException
- if persistency access failsvoid setOriginalPriority(WorkflowPriority originalPriority) throws PersistencyException
originalPriority
- the new original priorityPersistencyException
- if persistency access failsvoid setExpiryPriority(WorkflowPriority expiryPriority) throws PersistencyException
expiryPriority
- the new expiry priorityPersistencyException
- if persistency access failsISecurityMember getActivator() throws PersistencyException
ITask.getActivatorName()
even
if the task activator was deleted.PersistencyException
- if persistency access failsString getActivatorName() throws PersistencyException
ITask.getActivator()
for more details). Never returns null even if the task activator was deleted.
This method returns the original task activator name if the task is not expired or the expired task
activator name if the task is expired.PersistencyException
- if persistency access failsList<IUser> getActivatorUserCandidates() throws PersistencyException
PersistencyException
- if persistency access failsvoid setActivator(ISecurityMember activator) throws PersistencyException
activator
- the new activatorPersistencyException
- if persistency access failsISecurityMember getOriginalActivator() throws PersistencyException
ITask.getOriginalActivatorName()
even
if the original task activator was deleted.PersistencyException
- if persistency access failsString getOriginalActivatorName() throws PersistencyException
PersistencyException
- if persistency access failsvoid setOriginalActivator(ISecurityMember activator) throws PersistencyException
activator
- the activator of the taskPersistencyException
- if persistency access failsISecurityMember getExpiryActivator() throws PersistencyException
ITask.getExpiryActivatorName()
even if the expiry activator was deleted.PersistencyException
- if persistency access failsvoid setExpiryActivator(ISecurityMember expiryActivator) throws PersistencyException
expiryActivator
- the expiry activator or nullPersistencyException
- if persistency access failsString getExpiryActivatorName() throws PersistencyException
PersistencyException
- if persistency access failsDate getExpiryTimestamp() throws PersistencyException
PersistencyException
- if persistency access failsvoid setExpiryTimestamp(Date newExpiryTimestamp) throws PersistencyException
If no expiry-activator is set, the task will be destroyed on expiry.
newExpiryTimestamp
- the new expiry timestamp. Maybe null.PersistencyException
- if persistency access failsBusinessDuration getExpiresInBusinessDuration()
BusinessDuration
between now and expiryTimestamp
).
The duration calculation is done by the IBusinessCalendar
which is set on the task.null
if the expiryTimestamp
is not set.ITask.getExpiryTimestamp()
,
ITask.setExpiryTimestamp(Date)
,
IBusinessCalendar.getBusinessDuration(DateTime, DateTime)
boolean isExpired() throws PersistencyException
PersistencyException
- if persistency access failsboolean isExpiryTask() throws PersistencyException
PersistencyException
- if persistency access failsString getExpiryTaskStartElementPid() throws PersistencyException
PersistencyException
- if persistency access failsDate getDelayTimestamp() throws PersistencyException
TaskState.DELAYED
.PersistencyException
- if persistency access failsvoid setDelayTimestamp(Date newDelayTimestamp) throws PersistencyException
TaskState.DELAYED
.TaskState.DELAYED
.newDelayTimestamp
- the new delay timestamp. Maybe nullPersistencyException
- if persistency access failsIUser getWorkerUser() throws PersistencyException
ITask.getWorkerUserName()
to evaluate the name of the worker user
even if the worker user was deleted.PersistencyException
- if persistency access failsString getWorkerUserName() throws PersistencyException
PersistencyException
- if persistency access failsIWorkflowSession getWorkerSession() throws PersistencyException
TaskState.RESUMED
or TaskState.CREATED
.PersistencyException
- if persistency access failsString getRequestPath() throws PersistencyException
PersistencyException
- if persistency access failsString getFullRequestPath() throws PersistencyException
PersistencyException
- if persistency access failsDate getStartTimestamp() throws PersistencyException
PersistencyException
- if persistency access failsDate getEndTimestamp() throws PersistencyException
PersistencyException
- if persistency access failsBusinessDuration getBusinessRuntime()
Gets the BusinessDuration
between the creation (see ITask.getStartTimestamp()
) and the
completion (see ITask.getEndTimestamp()
) of this task.
The business runtime is calculated only when a task ends (state changes to TaskState.DONE
or TaskState.JOINING
).
To calculate the BusinessDuration
the IDefaultBusinessCalendar
of the task is used.
BusinessDuration
between creation and completion.
Returns null
if the task is not yet completed or the task has been completed before the
business runtime feature was introduced.ITask.getStartTimestamp()
,
ITask.getEndTimestamp()
,
IBusinessCalendar.getBusinessDuration(DateTime, DateTime)
Duration getWorkingTime()
Duration
during that any user has been working on this task.TaskState.CREATED
or TaskState.RESUMED
to TaskState.DONE
or TaskState.JOINING
).null
).
E.g.created at 12:00 - parked at 12:10 => workingTime = 10 minutes resumed at 12:30 - completed at 12:40 => workingTime = 10 minutes ------------------------------------------------------------------ Total workingTime = 20 minutes
Duration
.null
for the following situations:
boolean isPersistent()
IIntermediateEvent getIntermediateEvent() throws PersistencyException
PersistencyException
- if persistency access failsString getName() throws PersistencyException
PersistencyException
- if persistency access failsvoid setName(String name) throws PersistencyException
name
- the new name of the taskPersistencyException
- if persistency access failsString getDisplayNameTemplate() throws PersistencyException
PersistencyException
- if persistency access failsString getDescription() throws PersistencyException
PersistencyException
- if persistency access failsvoid setDescription(String description) throws PersistencyException
description
- the new name of the taskPersistencyException
- if persistency access failsString getDisplayDescriptionTemplate() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCategoryPath(String categoryPath)
ITask
. Use "/" as path separator.
null
or an empty string could be used to reset the category path.
categoryPath
- the category path of this ITask
.ITask.getCategoryPath()
,
ITask.getCategory()
,
Category
String getCategoryPath()
ITask
.
The method ITask.getCategory()
returns the corresponding Category
to the current set category path.
null
ITask.setCategoryPath(String)
,
ITask.getCategory()
,
Category
Category getCategory()
Category
of this ITask
. The Category
provides locale specific information
like the name or the description of a category path, as defined in the CMS. See Category
for more information.
The method ITask.setCategoryPath(String)
allows to set the category of a task.
Category
, corresponding to the current category path, never null
ITask.setCategoryPath(String)
,
ITask.getCategoryPath()
,
Category
@Deprecated String getKindCode() throws PersistencyException
category
to categorize the casePersistencyException
- if persistency access fails@Deprecated String getKindName() throws PersistencyException
category
to categorize the casePersistencyException
- if persistency access fails@Deprecated void setKind(String kindCode, String kindName) throws PersistencyException
category
to categorize the casekindCode
- the new task kind code. Maybe nullkindName
- the new task kind name. Maybe nullPersistencyException
- if persistency access fails@Deprecated String getProcessCategoryCode() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case process category code.
This method returns the same result as
ITask.getCase()
.getProcessCategoryCode()
PersistencyException
- if persistency access fails@Deprecated String getProcessCategoryName() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case process category name
This method returns the same result as
ITask.getCase()
.getProcessCategoryName()
PersistencyException
- if persistency access fails@Deprecated String getProcessCode() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case process code
This method returns the same result as
ITask.getCase()
.getProcessCode()
PersistencyException
- if persistency access fails@Deprecated String getProcessName() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case process name
This method returns the same result as
ITask.getCase()
.getProcessName()
PersistencyException
- if persistency access fails@Deprecated String getTypeCode() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case type code
This method returns the same result as
ITask.getCase()
.getTypeCode()
PersistencyException
- if persistency access fails@Deprecated String getTypeName() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case type name
This method returns the same result as
ITask.getCase()
.getTypeName()
PersistencyException
- if persistency access fails@Deprecated String getSubTypeCode() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case sub type code
This method returns the same result as
ITask.getCase()
.getSubTypeCode()
PersistencyException
- if persistency access fails@Deprecated String getSubTypeName() throws PersistencyException
category
to categorize the case or ITask.getCategory()
to categorize the taskGets the case sub type name
This method returns the same result as
ITask.getCase()
.getSubTypeName()
PersistencyException
- if persistency access failsDate getBusinessMilestoneTimestamp() throws PersistencyException
PersistencyException
- if persistency access failsvoid setBusinessMilestoneTimestamp(Date businessMilestoneTimestamp) throws PersistencyException
businessMilestoneTimestamp
- the new business milestone timestamp. Maybe null.PersistencyException
- if persistency access failsInteger getBusinessMainContactId() throws PersistencyException
Gets the case business main contact identifier. Maybe null.
This method returns the same result as
ITask.getCase()
.getBusinessMainContactId()
PersistencyException
- if persistency access failsString getBusinessMainContactName() throws PersistencyException
Gets the case business main contact name. Maybe null.
This method returns the same result as
ITask.getCase()
.getBusinessMainContactName()
PersistencyException
- if persistency access failsString getBusinessCreatorUser() throws PersistencyException
Gets the case business creator user. Maybe null.
This method returns the same result as
ITask.getCase()
.getBusinessCreatorUser()
PersistencyException
- if persistency access failsDate getBusinessStartTimestamp() throws PersistencyException
Gets the case business start timestamp. Maybe null.
This method returns the same result as
ITask.getCase()
.getBusinessStartTimestamp()
PersistencyException
- if persistency access failsString getBusinessObjectCode() throws PersistencyException
Gets the case business object code. Maybe null.
This method returns the same result as
ITask.getCase()
.getBusinessObjectCode()
PersistencyException
- if persistency access failsString getCustomVarCharField1() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomVarCharField1(String customVarCharField1) throws PersistencyException
customVarCharField1
- the custom varchar field 1. Maybe null.PersistencyException
- if persistency access failsString getCustomVarCharField2() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomVarCharField2(String customVarCharField2) throws PersistencyException
customVarCharField2
- the custom varchar field 2. Maybe null.PersistencyException
- if persistency access failsString getCustomVarCharField3() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomVarCharField3(String customVarCharField3) throws PersistencyException
customVarCharField3
- the custom varchar field 3. Maybe null.PersistencyException
- if persistency access failsString getCustomVarCharField4() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomVarCharField4(String customVarCharField4) throws PersistencyException
customVarCharField4
- the custom varchar field 4. Maybe null.PersistencyException
- if persistency access failsString getCustomVarCharField5() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomVarCharField5(String customVarCharField5) throws PersistencyException
customVarCharField5
- the custom varchar field 5. Maybe null.PersistencyException
- if persistency access failsNumber getCustomDecimalField1() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomDecimalField1(Number customDecimalField1) throws PersistencyException
customDecimalField1
- the custom decimal field 1. Maybe null.PersistencyException
- if persistency access failsNumber getCustomDecimalField2() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomDecimalField2(Number customDecimalField2) throws PersistencyException
customDecimalField2
- the custom decimal field 2. Maybe null.PersistencyException
- if persistency access failsNumber getCustomDecimalField3() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomDecimalField3(Number customDecimalField3) throws PersistencyException
customDecimalField3
- the custom decimal field 3. Maybe null.PersistencyException
- if persistency access failsNumber getCustomDecimalField4() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomDecimalField4(Number customDecimalField4) throws PersistencyException
customDecimalField4
- the custom decimal field 4. Maybe null.PersistencyException
- if persistency access failsNumber getCustomDecimalField5() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomDecimalField5(Number customDecimalField5) throws PersistencyException
customDecimalField5
- the custom decimal field 5. Maybe null.PersistencyException
- if persistency access failsDate getCustomTimestampField1() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomTimestampField1(Date customTimestampField1) throws PersistencyException
customTimestampField1
- the custom timestamp field 1. Maybe null.PersistencyException
- if persistency access failsDate getCustomTimestampField2() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomTimestampField2(Date customTimestampField2) throws PersistencyException
customTimestampField2
- the custom timestamp field 2. Maybe null.PersistencyException
- if persistency access failsDate getCustomTimestampField3() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomTimestampField3(Date customTimestampField3) throws PersistencyException
customTimestampField3
- the custom timestamp field 3. Maybe null.PersistencyException
- if persistency access failsDate getCustomTimestampField4() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomTimestampField4(Date customTimestampField4) throws PersistencyException
customTimestampField4
- the custom timestamp field 4. Maybe null.PersistencyException
- if persistency access failsDate getCustomTimestampField5() throws PersistencyException
PersistencyException
- if persistency access failsvoid setCustomTimestampField5(Date customTimestampField5) throws PersistencyException
customTimestampField5
- the custom timestamp field 5. Maybe null.PersistencyException
- if persistency access failsList<IPageArchive> getPageArchives() throws PersistencyException
IPageArchive
PersistencyException
- if persistency access failsIPageArchive getPageArchive(long pageArchiveIdentifier) throws PersistencyException
pageArchiveIdentifier
- the identifier of the page archiveIPageArchive
archive or nullPersistencyException
- if persistency access failsList<IWorkflowEvent> getWorkflowEvents() throws PersistencyException
PersistencyException
- if persistency access failsvoid destroy() throws PersistencyException
PersistencyException
- if persistency access failsvoid reset() throws PersistencyException
Resets this task to the task start.
This method can be called if the task is in one of the following states:
After the method was called the task will be in the stateTaskState.SUSPENDED
.
It may also be in state TaskState.UNASSIGNED
if the task activator was deleted.PersistencyException
- if persistency access failsCompositeObject getStartProcessData() throws PersistencyException
PersistencyException
- if persistency access failsCompositeObject getEndProcessData() throws PersistencyException
PersistencyException
- if persistency access failsInteger getNumberOfResumes()
TaskState.RESUMED
).
For the first task of a case the resume count is automatically set to one.null
if the task was completed before this feature was introduced.void setBusinessCalendar(IBusinessCalendar calendar)
IBusinessCalendar
for this ITask
.
This influences the IDefaultBusinessCalendar
determination when calling ivy.cal
.calendar
- may be null.ILocationService locations()
Gets the locations of the task.
Example:
import ch.ivyteam.ivy.location.ILocation;
ILocation location = ivy.task.locations().getLatest();
if (location != null)
{
ivy.log.info("Last known position somebody has worked on the task "+ivy.task.getId()+" was "+location.getPosition());
}
Copyright © 2024
AXON IVY AG
All Rights Reserved Documentation was generated
on April 28, 2024