org.csapi.jr.se.ui
Interface CallRelatedSendInfo

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

public interface CallRelatedSendInfo
extends Activity

A call related 'Send Info' activity object.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Activity
ACTIVE_STATE, IDLE_STATE, INVALID_STATE
 
Method Summary
 void abortActionReq()
          This asynchronous method aborts a user interaction operation, for example, a sendInfoReq(), from the specified call leg.
 void addCallRelatedSendInfoListener(org.csapi.jr.se.ui.CallRelatedSendInfoListener callRelatedSendInfoListener)
          Adds a CallRelatedSendInfoListener which is interested in events generated by the CallRelatedSendInfo.
 org.csapi.jr.se.ui.UICall getUICall()
          Returns a reference to the UICall responsible for creation of the CallRelatedSendInfo.
 void removeCallRelatedSendInfoListener(org.csapi.jr.se.ui.CallRelatedSendInfoListener callRelatedSendInfoListener)
          Removes a CallRelatedSendInfoListener which is no longer interested events generated by the CallRelatedSendInfo.
 void sendInfoReq(org.csapi.jr.se.ui.UIInfo info, java.lang.String language, org.csapi.jr.se.ui.UIVariableInfo[] variableInfo, int repeatIndicator, int responseRequested)
          This asynchronous method plays an announcement or sends other information to the user.
 
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 CallRelatedSendInfo.

Returns:
The UICall responsible for creation of the CallRelatedSendInfo

addCallRelatedSendInfoListener

public void addCallRelatedSendInfoListener(org.csapi.jr.se.ui.CallRelatedSendInfoListener callRelatedSendInfoListener)
Adds a CallRelatedSendInfoListener which is interested in events generated by the CallRelatedSendInfo.

Parameters:
callRelatedSendInfoListener - Reference to the CallRelatedSendInfoListener which is to be added as a listener.

removeCallRelatedSendInfoListener

public void removeCallRelatedSendInfoListener(org.csapi.jr.se.ui.CallRelatedSendInfoListener callRelatedSendInfoListener)
Removes a CallRelatedSendInfoListener which is no longer interested events generated by the CallRelatedSendInfo.

Parameters:
callRelatedSendInfoListener - Reference to the CallRelatedSendInfoListener which is to be removed as a listener.

sendInfoReq

public void sendInfoReq(org.csapi.jr.se.ui.UIInfo info,
                        java.lang.String language,
                        org.csapi.jr.se.ui.UIVariableInfo[] variableInfo,
                        int repeatIndicator,
                        int responseRequested)
                 throws PlatformException,
                        java.lang.IllegalStateException,
                        CommonException,
                        InvalidNetworkStateException,
                        IllegalIdException
This asynchronous method plays an announcement or sends other information to the user.

Parameters:
info - Specifies the information to send to the user.
This information can be:
- an infoID, identifying pre-defined information to be send (announcement and/or text); - a string, defining the text to be sent; - a URL, identifying pre-defined information or data to be sent to or downloaded into the terminal.
language - Specifies the language of the information to be send to the user
variableInfo - Defines the variable part of the information to send to the user
repeatIndicator - Defines how many times the information shall be sent to the end-user.
A value of zero (0) indicates that the announcement shall be repeated until the call or call leg is released or an abortActionReq() is sent
responseRequested - Specifies if a response is required from the call user interaction service, and any action the service should take
Throws:
PlatformException - if the implementation detected an internal (for example, communication) error
java.lang.IllegalStateException - if the JR API object is not in a state suitable for the invocation
CommonException - defines the structure of the exception class which is applicable to all methods
InvalidNetworkStateException - if the sequence of method calls is allowed by the gateway but the underlying protocol can not support it
IllegalIdException - if an information id specified is invalid

abortActionReq

public void abortActionReq()
                    throws PlatformException,
                           java.lang.IllegalStateException,
                           CommonException
This asynchronous method aborts a user interaction operation, for example, a sendInfoReq(), from the specified call leg. The call and call leg are otherwise unaffected. The user interaction call service interrupts the current action on the specified leg.

Throws:
PlatformException - if the implementation detected an internal (for example, communication) error
java.lang.IllegalStateException - if the JR API object is not in a state suitable for the invocation
CommonException - defines the structure of the exception class which is applicable to all methods