CTICiscoCallVars object

One possible CTICiscoReturn property is a CTICiscoCallVars object which supports get methods for each of the Cisco ICM call variables.

One possible CTICiscoReturn property is a CTICiscoCallVars object. Some methods require various Call Variables to be passed to, or returned from, the Cisco ICM. When passing Call Variables or ECC Variables in to the ICM, a CTICiscoCallVariable object should be created and then each required value is set by calling the appropriate set method. For example, to set the CallVariable1 value, use the method setCallVarFlag1(<value of flag to be set>).

When a Call Variable or an ECC Variable is returned, a CallVars object must first be retrieved from the CTICiscoReturn object. The Call Variable or ECC Variable can then be accessed using the relevant get method.

Here is an example of how CTICiscoCallVars is used:

CTICiscoICM icm = new CTICiscoICM (myConnectionItem);
CTICiscoReturn ret;
ret = icm.connect();
// 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 returned values
  CallVars cv = ret.getCallVars();
  // Check cv is not equal to null
  // (something has gone wrong if this is the case)
  if (cv == null) {
    // Something has gone wrong. Return the value of Status
    return Status;
  } else {
    // We have a call vars object so we can now pick up
    // the values we are interested in
    String CallVariable1 = cv.getCallVariable1();
    String CallVariable2 = cv.getCallVariable2();
    // And so on for all the variables the app is interested in
  }
}

Each value that can be returned has a get method associated with it. Here is a table of the available get and set methods for the CTICiscoCallVars object:

Table 1. get and set methods for the CTICiscoCallVars object
Variable name	get method	set method
CallVarFlag1	Integer getCallVarFlag1()	void setCallVarFlag1(Integer CallVarFlag1)
CallVarFlag...	Integer getCallVarFlag...()	void setCallVarFlag...(Integer CallVarFlag...)
CallVarFlag10	Integer getCallVarFlag10()	void setCallVarFlag10(Integer CallVarFlag10)
CallVariable1	String getCallVariable1()	void setCallVariable1(String CallVariable1)
CallVariable...	String getCallVariable...()	void setCallVariable...(String CallVariable...)
CallVariable10	String getCallVariable10()	void setCallVariable10(String CallVariable10)
ECCVarArrayIndex1	Integer getECCVarArrayIndex1()	void setECCVarArrayIndex1(Integer)
ECCVarArrayIndex...	Integer getECCVarArrayIndex...()	void setECCVarArrayIndex...(Integer ECCVarArrayIndex1)
ECCVarArrayIndex5	Integer getECCVarArrayIndex5()	void setECCVarArrayIndex5(Integer ECCVarArrayIndex5)
ECCVarArrayString1	String getECCVarArrayString1()	void setECCVarArrayString1(String)
ECCVarArrayString...	String getECCVarArrayString...()	void setECCVarArrayString...(String ECCVarArrayString1)
ECCVarArrayString5	String getECCVarArrayString5()	void setECCVarArrayString5(String ECCVarArrayString5)
ECCVarArrayTag1	Integer getECCVarArrayTag1	void setECCVarArrayTag1(Integer)
ECCVarArrayTag...	Integer getECCVarArrayTag...	void setECCVarArrayTag...(Integer ECCVarArrayTag1)
ECCVarArrayTag5	Integer getECCVarArrayTag5	void setECCVarArrayTag5(Integer ECCVarArrayTag5)
ECCVarValueString1	String getECCVarValueString1()	void setECCVarValueString1(String ECCVarValueString1)
ECCVarValueString...	String getECCVarValueString...()	void setECCVarValueString...(String ECCVarValueString...)
ECCVarValueString5	String getECCVarValueString5()	void setECCVarValueString5(String ECCVarValueString5)
ECCVarValueTag1	Integer getECCVarValueTag1()	void setECCVarValueTag1(Integer ECCVarValueTag1)
ECCVarValueTag...	Integer getECCVarValueTag...()	void setECCVarValueTag...(Integer ECCVarValueTag...)
ECCVarValueTag5	Integer getECCVarValueTag5()	void setECCVarValueTag5(Integer ECCVarValueTag5)
StatusVariable1	Integer getStatusVariable1()	void setStatusVariable1(Integer)
StatusVariable...	Integer getStatusVariable...()	void setStatusVariable...(Integer StatusVariable1)
StatusVariable16	Integer getStatusVariable16()	void setStatusVariable16(Integer StatusVariable16)