org.csapi.jr.se.ui
Interface RecordMessage

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

public interface RecordMessage
extends Activity

This interface represents a RecordMessage 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 addRecordMessageListener(org.csapi.jr.se.ui.RecordMessageListener recordMessageListener)
          Adds a RecordMessageListener which is interested in events generated by the RecordMessage.
 org.csapi.jr.se.ui.UICall getUICall()
          Returns a reference to the UICall responsible for creation of the RecordMessage.
 void recordMessageReq(org.csapi.jr.se.ui.UIInfo info, org.csapi.jr.se.ui.UIMessageCriteria criteria)
          Invokes the recordMessageReq() method on the Parlay Gateway.
 void removeRecordMessageListener(org.csapi.jr.se.ui.RecordMessageListener recordMessageListener)
          Removes a RecordMessageListener which is no longer interested events generated by the RecordMessage.
 
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 RecordMessage.

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

addRecordMessageListener

public void addRecordMessageListener(org.csapi.jr.se.ui.RecordMessageListener recordMessageListener)
Adds a RecordMessageListener which is interested in events generated by the RecordMessage.

Parameters:
recordMessageListener - A reference to the RecordMessageListener which is to be added as a listener.

removeRecordMessageListener

public void removeRecordMessageListener(org.csapi.jr.se.ui.RecordMessageListener recordMessageListener)
Removes a RecordMessageListener which is no longer interested events generated by the RecordMessage.

Parameters:
recordMessageListener - A reference to the RecordMessageListener which is to be removed as a listener.

recordMessageReq

public void recordMessageReq(org.csapi.jr.se.ui.UIInfo info,
                             org.csapi.jr.se.ui.UIMessageCriteria criteria)
                      throws PlatformException,
                             java.lang.IllegalStateException,
                             CommonException,
                             InvalidNetworkStateException,
                             IllegalIdException,
                             InvalidCriteriaException
Invokes the recordMessageReq() method on the Parlay Gateway.

PlatformException
java.lang.IllegalStateException
CommonException
InvalidNetworkStateException
IllegalIdException
InvalidCriteriaException

abortActionReq

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

PlatformException
java.lang.IllegalStateException
CommonException