|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public org.csapi.jr.se.ui.UICall getUICall()
public void addCallRelatedSendInfoAndCollectListener(org.csapi.jr.se.ui.CallRelatedSendInfoAndCollectListener callRelatedSendInfoAndCollectListener)
callRelatedSendInfoAndCollectListener
- Reference to the
CallRelatedSendInfoAndCollectListener which is to be added as a
listener.public void removeCallRelatedSendInfoAndCollectListener(org.csapi.jr.se.ui.CallRelatedSendInfoAndCollectListener callRelatedSendInfoAndCollectListener)
callRelatedSendInfoAndCollectListener
- Reference to the
CallRelatedSendInfoAndCollectListener which is to be removed as a
listener.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
info
- Specifies the ID of the information to send to the user.language
- Specifies the language of the information to be send to the uservariableInfo
- Defines the variable part of the information to send to the usercriteria
- 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
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 specifiedpublic void abortActionReq() throws PlatformException, java.lang.IllegalStateException, CommonException
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
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |