org.csapi.jr.se.ui
Interface GetMessage

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

public interface GetMessage
extends Activity

This interface represents a GetMessage activity object.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Activity
ACTIVE_STATE, IDLE_STATE, INVALID_STATE
 
Method Summary
 void abortActionReq()
          Invokes the abortActionReq() method on the Parlay Gateway.
 void addGetMessageListener(org.csapi.jr.se.ui.GetMessageListener getMessageListener)
          Adds a GetMessageListener which is interested in events generated by the GetMessage.
 void getMessageReq(int messageID)
          Invokes the getMessageReq() method on the Parlay Gateway.
 org.csapi.jr.se.ui.UICall getUICall()
          Returns a reference to the UICall responsible for creation of the GetMessage.
 void removeGetMessageListener(org.csapi.jr.se.ui.GetMessageListener getMessageListener)
          Removes a GetMessageListener which is no longer interested events generated by the GetMessage.
 
Methods inherited from interface org.csapi.jr.se.Activity
addActivityStateChangeListener, getState, removeActivityStateChangeListener
 

Method Detail

getUICall

public org.csapi.jr.se.ui.UICall getUICall()
Returns a reference to the UICall responsible for creation of the GetMessage.

Returns:
A reference to the UICall responsible for creation of the GetMessage.

addGetMessageListener

public void addGetMessageListener(org.csapi.jr.se.ui.GetMessageListener getMessageListener)
Adds a GetMessageListener which is interested in events generated by the GetMessage.

Parameters:
getMessageListener - A reference to the GetMessageListener which is to be added as a listener.

removeGetMessageListener

public void removeGetMessageListener(org.csapi.jr.se.ui.GetMessageListener getMessageListener)
Removes a GetMessageListener which is no longer interested events generated by the GetMessage.

Parameters:
getMessageListener - A reference to the GetMessageListener which is to be removed as a listener.

getMessageReq

public void getMessageReq(int messageID)
                   throws PlatformException,
                          java.lang.IllegalStateException,
                          CommonException,
                          InvalidNetworkStateException,
                          IllegalIdException
Invokes the getMessageReq() method on the Parlay Gateway.

PlatformException
java.lang.IllegalStateException
CommonException
InvalidNetworkStateException
IllegalIdException

abortActionReq

public void abortActionReq()
                    throws PlatformException,
                           java.lang.IllegalStateException,
                           CommonException
Invokes the abortActionReq() method on the Parlay Gateway.

PlatformException
java.lang.IllegalStateException
CommonException