Interface ICaseEventModel
- All Superinterfaces:
Serializable
This interface defines the properties of a case event from database.
- Since:
- 9.6
- Author:
- Radu Batori
-
Method Summary
Modifier and TypeMethodDescriptionGets the Application ID where this case event occurred.Gets the case the event is associated with.Gets the content data as a Map.Gets the content data as JSON exactly as stored in the database.long
getId()
Gets the Id of the entity.getName()
Gets the name of the event.If this event is a replay of another event, this method returns the ID of the original eventGets the status of the event.Gets the id of the task the event is associated with.Gets the datetime when the event was fired.getType()
Gets the type of the event.Gets the user who created the event.boolean
Indicates whether this event is a replay of another event.
-
Method Details
-
getId
long getId()Gets the Id of the entity.- Returns:
- the Id of the entity.
-
getApplicationId
ApplicationID getApplicationId()Gets the Application ID where this case event occurred. This is of significant importance for broadcast message events which are not linked to any particular case.- Returns:
- the application id
-
getTaskId
Long getTaskId()Gets the id of the task the event is associated with. If the event is not associated with any task the return value is 0.- Returns:
- the task id
-
getCaseId
Long getCaseId()Gets the case the event is associated with. May be null.- Returns:
- the case id
-
getName
String getName()Gets the name of the event.- Returns:
- the name
-
getType
CaseEventType getType()Gets the type of the event.- Returns:
- the type
-
getStatus
CaseEventStatusType getStatus()Gets the status of the event.- Returns:
- the status
-
getTimestamp
DateTimeValue getTimestamp()Gets the datetime when the event was fired.- Returns:
- the event fired timestamp
-
getUserName
String getUserName()Gets the user who created the event.- Returns:
- the username
-
getReplayedEventId
Long getReplayedEventId()If this event is a replay of another event, this method returns the ID of the original event- Returns:
- id of originating event
-
isReplayedEvent
boolean isReplayedEvent()Indicates whether this event is a replay of another event.- Returns:
- whether this event is a replay of another event.
-
getContent
Gets the content data as a Map. The Map should be unmodifiable.- Returns:
- the content data as a Map. The Map should be unmodifiable.
-
getContentAsJson
String getContentAsJson()Gets the content data as JSON exactly as stored in the database.- Returns:
- the content data as JSON exactly as stored in the database.
-