org.csapi.jr.se.pam.event
Interface ForEvent

All Superinterfaces:
Activity, CsapiInterface, java.io.Serializable

public interface ForEvent
extends Activity

This interface represents a ForEvent activity object.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Activity
ACTIVE_STATE, IDLE_STATE, INVALID_STATE
 
Method Summary
 void addForEventListener(org.csapi.jr.se.pam.event.ForEventListener forEventListener)
          Adds a ForEventListener which is interested in events generated by the ForEvent.
 org.csapi.jr.se.pam.event.PAMEventHandler getPAMEventHandler()
          Returns a reference to the PAMEventHandler responsible for creation of the ForEvent.
 void registerForEvent(org.csapi.jr.se.pam.PAMEventInfo[] eventList, int validFor, byte[] authToken)
          Invokes the registerForEvent() method on the Parlay Gateway.
 void removeForEventListener(org.csapi.jr.se.pam.event.ForEventListener forEventListener)
          Removes a ForEventListener which is no longer interested events generated by the ForEvent.
 
Methods inherited from interface org.csapi.jr.se.Activity
addActivityStateChangeListener, getState, removeActivityStateChangeListener
 

Method Detail

getPAMEventHandler

public org.csapi.jr.se.pam.event.PAMEventHandler getPAMEventHandler()
Returns a reference to the PAMEventHandler responsible for creation of the ForEvent.

Returns:
A reference to the PAMEventHandler responsible for creation of the ForEvent.

addForEventListener

public void addForEventListener(org.csapi.jr.se.pam.event.ForEventListener forEventListener)
Adds a ForEventListener which is interested in events generated by the ForEvent.

Parameters:
forEventListener - A reference to the ForEventListener which is to be added as a listener.

removeForEventListener

public void removeForEventListener(org.csapi.jr.se.pam.event.ForEventListener forEventListener)
Removes a ForEventListener which is no longer interested events generated by the ForEvent.

Parameters:
forEventListener - A reference to the ForEventListener which is to be removed as a listener.

registerForEvent

public void registerForEvent(org.csapi.jr.se.pam.PAMEventInfo[] eventList,
                             int validFor,
                             byte[] authToken)
                      throws PlatformException,
                             java.lang.IllegalStateException,
                             CommonException,
                             PamNotRegisteredException,
                             PamInvalidCredentialException
Invokes the registerForEvent() method on the Parlay Gateway.

PlatformException
java.lang.IllegalStateException
CommonException
PamNotRegisteredException
PamInvalidCredentialException