org.csapi.jr.se.ui
Interface CallRelatedSendInfoAndCollect

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

public interface CallRelatedSendInfoAndCollect
extends Activity

A call related 'Send Info And Collect' 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 addCallRelatedSendInfoAndCollectListener(org.csapi.jr.se.ui.CallRelatedSendInfoAndCollectListener callRelatedSendInfoAndCollectListener)
          Adds a CallRelatedSendInfoAndCollectListener which is interested in events generated by the CallRelatedSendInfoAndCollect.
 org.csapi.jr.se.ui.UICall getUICall()
          Returns a reference to the UICall responsible for creation of the CallRelatedSendInfoAndCollect.
 void removeCallRelatedSendInfoAndCollectListener(org.csapi.jr.se.ui.CallRelatedSendInfoAndCollectListener callRelatedSendInfoAndCollectListener)
          Removes a CallRelatedSendInfoAndCollectListener which is no longer interested events generated by the CallRelatedSendInfoAndCollect.
 void sendInfoAndCollectReq(org.csapi.jr.se.ui.UIInfo info, java.lang.String language, org.csapi.jr.se.ui.UIVariableInfo[] variableInfo, org.csapi.jr.se.ui.UICollectCriteria criteria, int responseRequested)
          This asynchronous method plays an announcement or sends other information to the user and collects some information from 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 CallRelatedSendInfoAndCollect.

Returns:
The UICall responsible for creation of the CallRelatedSendInfoAndCollect

addCallRelatedSendInfoAndCollectListener

public void addCallRelatedSendInfoAndCollectListener(org.csapi.jr.se.ui.CallRelatedSendInfoAndCollectListener callRelatedSendInfoAndCollectListener)
Adds a CallRelatedSendInfoAndCollectListener which is interested in events generated by the CallRelatedSendInfoAndCollect.

Parameters:
callRelatedSendInfoAndCollectListener - Reference to the CallRelatedSendInfoAndCollectListener which is to be added as a listener.

removeCallRelatedSendInfoAndCollectListener

public void removeCallRelatedSendInfoAndCollectListener(org.csapi.jr.se.ui.CallRelatedSendInfoAndCollectListener callRelatedSendInfoAndCollectListener)
Removes a CallRelatedSendInfoAndCollectListener which is no longer interested events generated by the CallRelatedSendInfoAndCollect.

Parameters:
callRelatedSendInfoAndCollectListener - Reference to the CallRelatedSendInfoAndCollectListener which is to be removed as a listener.

sendInfoAndCollectReq

public void sendInfoAndCollectReq(org.csapi.jr.se.ui.UIInfo info,
                                  java.lang.String language,
                                  org.csapi.jr.se.ui.UIVariableInfo[] variableInfo,
                                  org.csapi.jr.se.ui.UICollectCriteria criteria,
                                  int responseRequested)
                           throws PlatformException,
                                  java.lang.IllegalStateException,
                                  CommonException,
                                  InvalidNetworkStateException,
                                  IllegalIdException,
                                  InvalidCriteriaException,
                                  IllegalRangeException,
                                  InvalidCollectionCriteriaException
This asynchronous method plays an announcement or sends other information to the user and collects some information from the user. The announcement usually prompts for a number of characters (for example, these are digits or text strings such as "YES" if the user's terminal device is a phone).

Parameters:
info - Specifies the ID of 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
criteria - Specifies additional properties for the collection of information, such as the maximum and minimum number of characters, end character, first character timeout and inter-character timeout.
responseRequested - Specifies if a response is required from the call user interaction service, and any action the service should take. For this case it can especially be used to indicate, for example, the final request
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
InvalidCriteriaException - if invalid criteria specified
IllegalRangeException - if the values for minimum and maximum collection length are out of range
InvalidCollectionCriteriaException - if invalid collection criteria specified

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