CTICiscoReturn object

The methods supported by the CTICiscoICM object all return a CTICiscoReturn object. The CTICiscoReturn object has a get method for each possible return property. The validity of a return property depends on which CTICiscoICM method is invoked. The description of each of the CTICiscoICM methods explains which return property (or properties) are valid. If a return value is not set, the relevant get method will return null. Before a return value is used it should be checked that the value is not equal to null.

Here is an example of how CTICiscoReturn is used:

CTICiscoICM icm = new CTICiscoICM (myConnectionItem);
CTICiscoReturn ret;
// Issue a 'release' to the ICM
ret = icm.release();
// Firstly check that the Status is equal to zero
Integer Status = ret.getStatus();
if (Status.intValue() != 0) {
  // Status is non-zero. At this point an app would normally
  // log this status value and return
  return Status;
} else {
  // Status is zero so we can pickup the CauseCode
  Integer MyCauseCode = ret.getCause();
}

Each value that can be returned has a get method associated with it, for example, getStatus will return the status from the CTICiscoReturn object. Here is a table of the available get methods for the CTICiscoReturn object:

Table 1. get methods for the CTICiscoReturn object
Return values	get method
ANI	String getANI()
CallerEnteredDigits	String getCallerEnteredDigits()
CallVars	CTICiscoCallVars getCTICiscoCallVars()
Cause	Integer getCause()
ErrorCode	Integer getErrorCode()
Event	Integer getEvent()
InvokeID	Integer getInvokeID()
Label	String getLabel()
LabelType	Integer getLabelType()
RequestID	Integer getRequestID()
ScriptConfiguration	String getScriptConfiguration()
ScriptID	String getScriptID()
ServiceID	Integer getServiceID()
Status	Integer getStatus()
TransferHint	Integer getTransferHint()