Sets the status of an
event in the
event store.
Syntax
public abstract void setEventStatus(String eventID, int status);
Parameters
- eventID
- Is the event ID of the event whose status is changed.
- status
- Is one of the following event-status constants to identify the new status
of the specified event:
CWConnectorEventStatus.READY_FOR_POLL
CWConnectorEventStatus.IN_PROGRESS
CWConnectorEventStatus.SUCCESS
CWConnectorEventStatus.UNSUBSCRIBED
CWConnectorEventStatus.ERROR_POSTING_EVENT
CWConnectorEventStatus.ERROR_OBJECT_NOT_FOUND
CWConnectorEventStatus.ERROR_PROCESSING_EVENT
Return values
None.
Exceptions
- InvalidStatusChangeException
- Thrown when the status is being changed to an invalid status
value for the application.
Notes
The setEventStatus() method performs the following
actions:
- Check if the status value is valid, throwing the
InvalidStatusChangeException exception if it is not.
- Change the status of the event identified by eventID in the
application's event store.
- Important:
- The setEventStatus() method is an abstract
method.Therefore, the event-store class must implement this
method to provide the ability to set the status of an event in the event
store.
The connector must ensure that the change in event status is committed in
the underlying application.
See also
updateEventStatus()
