com.ibm.websphere.cem
Interface ECSController

All Known Implementing Classes:
ECSControllerImpl

public interface ECSController

See Also:
ECSEmitter

Method Summary
 java.lang.String clearEcsID()
          Removes the current instance of the event correlation sphere from this thread.
 java.lang.String getCurrentEcsID()
          Returns the name of the current instance of this event correlation sphere
 java.lang.String getPreviousEcsID()
          Returns the name of the previous instance of this event correlation sphere
 java.lang.String setNewEcsID(java.lang.String id)
          Associates a new event correlation sphere with this thread, and makes it current.
 

Method Detail

setNewEcsID

public java.lang.String setNewEcsID(java.lang.String id)
Associates a new event correlation sphere with this thread, and makes it current. Pushes the properties object that had been till now associated with this ecsID. It can subsequently be popped by calling clearECSId

Parameters:
id - The ID of the new event correlation sphere
Returns:
The ID of the previously current event correlation sphere instance or null if there was none
Throws:
InvalidParameterException - When id is null
DuplicateIdentifierException - When id already exists for this ECS

clearEcsID

public java.lang.String clearEcsID()
Removes the current instance of the event correlation sphere from this thread. Pops the properties object previously associated with this context type and makes it current

Returns:
The name of the newly current event correlation sphere instance or null if there is none

getCurrentEcsID

public java.lang.String getCurrentEcsID()
Returns the name of the current instance of this event correlation sphere

Returns:
The name of the current event correlation sphere instance or null if there is none

getPreviousEcsID

public java.lang.String getPreviousEcsID()
Returns the name of the previous instance of this event correlation sphere

Returns:
The name of the previous event correlation sphere instance or null if there is none