com.ibm.ws.javax.activity
Class CoordinationInformation

java.lang.Object
  |
  +--com.ibm.ws.javax.activity.CoordinationInformation
public class CoordinationInformation
extends java.lang.Object

A CoordinationInformation object is returned from the SignalSet's setResponse method. It is used by the ActivityCoordinator to determine how next to proceed during Signaling after a response from a particular Action has been processed by the SignalSet.

Constructor Summary
CoordinationInformation(boolean isActionInterested, boolean useNextSignal)
          Constructs a CoordinationInformation object to indicate to the calling ActivityCoordinator how to proceed with signaling.
 
Method Summary
 boolean isActionInterested()
          Returns a boolean to indicate to the calling ActivityCoordinator whether the Action, whose Outcome was processed by the the call to setResponse that returned the target CoordinationInformation object, should receive any further signals during the current broadcast.
 boolean useNextSignal()
          Returns a boolean to indicates to the calling ActivityCoordinator whether it should request the next Signal from the SignalSet even if the current Signal has not yet been distributed to all registered Actions.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CoordinationInformation

public CoordinationInformation(boolean isActionInterested,
                               boolean useNextSignal)
Constructs a CoordinationInformation object to indicate to the calling ActivityCoordinator how to proceed with signaling. This object is created by a SignalSet during the processing of a setResponse operation.

Parameters:
isActionInterested - indicates to the calling ActivityCoordinator whether the Action, whose Outcome is being processed by setResponse, should receive any further signals during the current broadcast. A value of true indicates that the Action should continue to receive signals. A value of false indicates that the Action is in a state where is expects no further signals.
useNextSignal - indicates to the calling ActivityCoordinator that it should request the next Signal from the SignalSet even if the current Signal has not yet been distributed to all registered Actions. A value of true indicates that the next Signal should be requested and distributed to registered Actions. A value of false indicates that the current Signal should continue to be distributed.
Method Detail

isActionInterested

public boolean isActionInterested()
Returns a boolean to indicate to the calling ActivityCoordinator whether the Action, whose Outcome was processed by the the call to setResponse that returned the target CoordinationInformation object, should receive any further signals during the current broadcast. A value of true indicates that the Action should continue to receive signals. A value of false indicates that the Action is in a state where is expects no further signals.

Returns:
true
if the Action whose Outcome has been processed should receive further signals during the current broadcast.
false
if the Action whose Outcome has been processed is in a state where it expects no further signals.

useNextSignal

public boolean useNextSignal()
Returns a boolean to indicates to the calling ActivityCoordinator whether it should request the next Signal from the SignalSet even if the current Signal has not yet been distributed to all registered Actions.

Returns:
true
if the the next Signal should be requested and distributed to registered Actions.
false
if the current Signal should continue to be distributed.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.