com.ibm.di.api
Class CIEvent
java.lang.Object
com.ibm.di.api.DIEvent
com.ibm.di.api.CIEvent
- All Implemented Interfaces:
- Serializable
public class CIEvent
- extends DIEvent
This class is the object that describes the event that have been triggered.
Its purpose is to be an information carrier for events that have impact on an
ConfigInstance
.
- See Also:
- Serialized Form
CIEvent
public CIEvent(String aType,
String aId,
Object aData,
String aConfigInstanceId,
long aStarted,
String aGUID,
boolean aCreateTS)
throws DIException
- Parameters:
aType
- the type of the event that had occurred.
Predefined constants:
DIEvent.EVT_CI_START
DIEvent.EVT_CI_STOP
DIEvent.EVT_CI_UPDATED
DIEvent.EVT_AL_START
DIEvent.EVT_AL_STOP
DIEvent.EVT_SRV_STOP
aId
- the ID of the event Note: This ID should not to be
think of as a Unique Identifier used for distinguishing
different events occurring in the system.aData
- the additional information this event carrier might contain.aConfigInstanceId
- the config instance id.aStarted
- the time the config instance was started.aGUID
- the globally unique identifier (GUID) of the ConfigInstance.aCreateTS
- tells whether a TombStorne was created for this event.
- Throws:
DIException
- if the aType
parameter is null
.
getStarted
public long getStarted()
- Retrives the time the config instance was started.
- Returns:
- the time the config instance was started.
getGUID
public String getGUID()
- Retrieves global ID.
- Returns:
- the globally unique identifier (GUID) of the AssemblyLine.
createTombstone
public boolean createTombstone()
- Checks if a tombstone should created.
- Returns:
- true if a TombStone is to be created for this event, false
otherwise.
toString
public String toString()
- Converts event to a readable output.
- Overrides:
toString
in class DIEvent
- Returns:
- the
String
representation of this object.