Package ch.ivyteam.ivy.workflow
Interface IWorkflowEvent
-
public interface IWorkflowEvent
Holds information about a event / operation that was done with a wf object (task or case)- Version:
- ReW 24.4.2001 created
- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<String>
getAdditionalInfo()
Gets the additional event informationICase
getCase()
Gets the case this event belongs to.long
getCaseId()
Gets the case identifierCaseState
getCaseState()
Gets the case stateWorkflowEventKind
getEventKind()
Gets the event kindDate
getEventTimestamp()
Gets the event timestamplong
getId()
The identifier of the workflow eventITask
getTask()
Gets the task this event belongs to.Long
getTaskId()
Gets the task identifier.TaskState
getTaskState()
Gets the task state.IUser
getUser()
Gets the user which is responsible for this event.String
getUserName()
Gets the name of the user which is responsible for this event.boolean
isTaskEvent()
Returns true if this event belongs to a task, otherwise false
-
-
-
Method Detail
-
getId
long getId()
The identifier of the workflow event- Returns:
- id
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getEventKind
WorkflowEventKind getEventKind()
Gets the event kind- Returns:
- event kind
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getAdditionalInfo
List<String> getAdditionalInfo()
Gets the additional event information- Returns:
- list with additional event information
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getEventTimestamp
Date getEventTimestamp()
Gets the event timestamp- Returns:
- event timestamp
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getUser
IUser getUser()
Gets the user which is responsible for this event. If the user was deleted since this event happened this method returns null. Use methodgetUserName()
to evaluate the name of the user even if the user was deleted.- Returns:
- user or null
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getUserName
String getUserName()
Gets the name of the user which is responsible for this event. This method will not return null even if the user was deleted since the event happened- Returns:
- user name
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getCaseId
long getCaseId()
Gets the case identifier- Returns:
- case identifier
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getTaskId
Long getTaskId()
Gets the task identifier. Returns null if this is a case specific event- Returns:
- task identifier or null.
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
isTaskEvent
boolean isTaskEvent()
Returns true if this event belongs to a task, otherwise false- Returns:
- true if event belongs to a task, otherwise false
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getCaseState
CaseState getCaseState()
Gets the case state- Returns:
- case state
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getTaskState
TaskState getTaskState()
Gets the task state. Returns null if workflow event is case specific- Returns:
- task state or null
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getTask
ITask getTask()
Gets the task this event belongs to. Returns null if event does not belong to a task.- Returns:
- task or null.
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getCase
ICase getCase()
Gets the case this event belongs to.- Returns:
- case
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
-