JCAT
v0.3.1

javax.csapi.cc.jcc
Interface MidCallData


public interface MidCallData

An instance of this MidCallData interface is returned by JccConnection.getMidCallData() after an event with id JccConnectionEvent.CONNECTION_MID_CALL occured. This interface provides access to the type of service code and (optionally) a string (with e.g. digits) associated with it.

Since:
1.0b

Field Summary
static int SERVICE_CODE_DIGITS
          getServiceCodeType() return constant: the user entered a digit sequence during the call, the corresponding value (returned by getServiceCodeValue()) is an ascii representation of the received digits.
static int SERVICE_CODE_FACILITY
          getServiceCodeType() return constant: a facility information element is received, the corresponding value (returned by getServiceCodeValue()) contains the facility information element as defined in ITU Q.932.
static int SERVICE_CODE_HOOKFLASH
          getServiceCodeType() return constant: the user performed a hookflash, optionally followed by some digits.
static int SERVICE_CODE_RECALL
          getServiceCodeType() return constant: the user pressed the register recall button, optionally followed by some digits.
static int SERVICE_CODE_U2U
          getServiceCodeType() return constant: a user-to-user message was received.
static int SERVICE_CODE_UNDEFINED
          getServiceCodeType() return constant: the type of service code is unknown, the corresponding value (returned by getServiceCodeValue()) is operator specific.
 
Method Summary
 int getServiceCodeType()
          Returns the type of the mid call event.
 java.lang.String getServiceCodeValue()
          Returns the value of the mid call event.
 

Field Detail

SERVICE_CODE_UNDEFINED

public static final int SERVICE_CODE_UNDEFINED
getServiceCodeType() return constant: the type of service code is unknown, the corresponding value (returned by getServiceCodeValue()) is operator specific.

See Also:
Constant Field Values

SERVICE_CODE_DIGITS

public static final int SERVICE_CODE_DIGITS
getServiceCodeType() return constant: the user entered a digit sequence during the call, the corresponding value (returned by getServiceCodeValue()) is an ascii representation of the received digits.

See Also:
Constant Field Values

SERVICE_CODE_FACILITY

public static final int SERVICE_CODE_FACILITY
getServiceCodeType() return constant: a facility information element is received, the corresponding value (returned by getServiceCodeValue()) contains the facility information element as defined in ITU Q.932.

See Also:
Constant Field Values

SERVICE_CODE_U2U

public static final int SERVICE_CODE_U2U
getServiceCodeType() return constant: a user-to-user message was received. The associated value (returned by getServiceCodeValue()) contains the content of the user-to-user information element. value (returned by getServiceCodeValue())

See Also:
Constant Field Values

SERVICE_CODE_HOOKFLASH

public static final int SERVICE_CODE_HOOKFLASH
getServiceCodeType() return constant: the user performed a hookflash, optionally followed by some digits. The corresponding value (returned by getServiceCodeValue()) is an ascii representation of the entered digits.

See Also:
Constant Field Values

SERVICE_CODE_RECALL

public static final int SERVICE_CODE_RECALL
getServiceCodeType() return constant: the user pressed the register recall button, optionally followed by some digits. The corresponding value (returned by getServiceCodeValue()) is an ascii representation of the entered digits.

See Also:
Constant Field Values
Method Detail

getServiceCodeType

public int getServiceCodeType()
Returns the type of the mid call event.

Returns:
an int representing the type of the mid call event. Only SERVICE_CODE_UNDEFINED, SERVICE_CODE_DIGITS, SERVICE_CODE_FACILITY, SERVICE_CODE_U2U, SERVICE_CODE_HOOKFLASH or SERVICE_CODE_RECALL are valid return values.

getServiceCodeValue

public java.lang.String getServiceCodeValue()
Returns the value of the mid call event.

Returns:
a string representing the value of the mid call event. If no value is availabe (e.g. getServiceCodeType() returns SERVICE_CODE_HOOKFLASH) then null is returned.

JCAT
v0.3.1

August, 2003
If you have any comments or queries, please mail them to JSR-122-EG@JCP.ORG

Copyright - 2001, 2003 Sun Microsystems