com.ibm.di.api
Class ALEvent

java.lang.Object
  com.ibm.di.api.DIEvent
      com.ibm.di.api.ALEvent

All Implemented Interfaces:

Serializable

public class ALEvent
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 AssemblyLine.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.di.api.DIEvent

EVT_AL_START, EVT_AL_STOP, EVT_CI_START, EVT_CI_STOP, EVT_CI_UPDATED, EVT_SRV_STOP, EVT_USER_PREFIX

Constructor Summary

ALEvent(String aType, String aId, Object aData, String aConfigInstanceId, TaskStatistics aStats)
Creates new ALEvent instance.

ALEvent(String aType, String aId, Object aData, String aConfigInstanceId, TaskStatistics aStats, String aGUID, String aUserMessage)
Creates new ALEvent instance.

Method Summary

String	getGUID() Retrieves global ID.
TaskStatistics	getStatistics() Retrives staristics.
String	getUserMessage() Retrieves a custom user message.
String	toString() Converts event to readable output.

Methods inherited from class com.ibm.di.api.DIEvent

getConfigInstanceId, getData, getDateCreated, getId, getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ALEvent

public ALEvent(String aType,
               String aId,
               Object aData,
               String aConfigInstanceId,
               TaskStatistics aStats)
        throws DIException

Creates new ALEvent instance.

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
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 configInstance id, this might be null.

aStats - the TaskStatistics object which carries information about the running AssemblyLine instance at the time when the event had occurred.

Throws:

DIException - if the aType parameter is null.

ALEvent

public ALEvent(String aType,
               String aId,
               Object aData,
               String aConfigInstanceId,
               TaskStatistics aStats,
               String aGUID,
               String aUserMessage)
        throws DIException

Creates new ALEvent instance.

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 configInstance id, this might be null.

aStats - the TaskStatistics object which carries information about the running AssemblyLine instance at the time when the event had occurred.

aGUID - the globally unique identifier (GUID) of the AssemblyLine.

aUserMessage - a custom user message, usually used when storing TombStones

Throws:

DIException - if the aType parameter is null.

Method Detail

getStatistics

public TaskStatistics getStatistics()

Retrives staristics.

Returns:

the TaskStatistics object, that holds the statistics information about the running AssemblyLine at the time the event has occurred.

getGUID

public String getGUID()

Retrieves global ID.

Returns:

the globally unique identifier (GUID) of the AssemblyLine.

getUserMessage

public String getUserMessage()

Retrieves a custom user message.

Returns:

a custom user message, usually used when storing TombStones

toString

public String toString()

Converts event to readable output.

Overrides:

toString in class DIEvent

Returns:

the String representation of this ALEvent object, containing all of its attributes.