public interface SystemEvent extends Serializable
SystemEventSender
, or as the result of the scheduled firing of a job.ScheduledJob
,
SystemEventSender
Modifier and Type | Method and Description |
---|---|
Boolean |
getCanResume()
This differs from
getCanRetry() in that this setting determines whether or not the event is capable is resuming
operation after being interrupted as the result of catastrophic server failure, or other database connection failure. |
Boolean |
getCanRetry() |
Date |
getCreated()
When the event was created.
|
Boolean |
getEnabled()
Whether the event is enabled.
|
Map<String,SystemEventDetail> |
getEventDetails()
Detailed information needed to consume the event appropriately.
|
Long |
getId() |
Integer |
getPriority()
The priority of an event.
|
Long |
getProcessMarker()
An arbitrary marker field used to group events together.
|
Integer |
getRetryCount()
Not currently supported.
|
EventScopeType |
getScopeType()
Describes how an event should be consumed.
|
Boolean |
getSerialExecution()
Whether this events should be the only event of it's type allowed to execute at once.
|
String |
getType()
Arbitrary string that identifies the event.
|
Boolean |
getUniversal()
Events marked as universal are considered to always be the same whenever they are fired.
|
EventWorkerType |
getWorkerType()
The type of node that is qualified to consume this event.
|
boolean |
isPassedConsumption()
Whether the event was successfully consumed
|
void |
setCanRetry(Boolean canRetry) |
void |
setCreated(Date created) |
void |
setEnabled(Boolean enabled) |
void |
setEventDetails(Map<String,SystemEventDetail> eventDetails) |
void |
setId(Long id) |
void |
setPassedConsumption(boolean passedConsumption) |
void |
setPriority(Integer priority) |
void |
setProcessMarker(Long processMarker) |
void |
setRetryCount(Integer retryCount)
Not currently supported.
|
void |
setScopeType(EventScopeType scopeType) |
void |
setSerialExecution(Boolean serialExecution) |
void |
setType(String type) |
void |
setUniversal(Boolean universal) |
void |
setWorkerType(EventWorkerType workerType) |
Date getCreated()
void setCreated(Date created)
Map<String,SystemEventDetail> getEventDetails()
ScheduledJob
void setEventDetails(Map<String,SystemEventDetail> eventDetails)
Long getId()
void setId(Long id)
String getType()
SystemEventConsumer.getEventType()
void setType(String type)
EventScopeType getScopeType()
getWorkerType()
nodes in the cluster.void setScopeType(EventScopeType scopeType)
Boolean getEnabled()
void setEnabled(Boolean enabled)
Long getProcessMarker()
void setProcessMarker(Long processMarker)
EventWorkerType getWorkerType()
void setWorkerType(EventWorkerType workerType)
Boolean getUniversal()
void setUniversal(Boolean universal)
Boolean getSerialExecution()
SerialEventLock
void setSerialExecution(Boolean serialExecution)
Integer getRetryCount()
void setRetryCount(Integer retryCount)
retryCount
- The number of times to try to consume the event before giving upBoolean getCanRetry()
void setCanRetry(Boolean canRetry)
boolean isPassedConsumption()
void setPassedConsumption(boolean passedConsumption)
Integer getPriority()
void setPriority(Integer priority)
Boolean getCanResume()
getCanRetry()
in that this setting determines whether or not the event is capable is resuming
operation after being interrupted as the result of catastrophic server failure, or other database connection failure.
See ProcessManager
for more information.Copyright © 2019. All rights reserved.