org.csapi.jr.se.cc
Class CallEventType

java.lang.Object
  |
  +--org.csapi.jr.se.cc.CallEventType
All Implemented Interfaces:
java.io.Serializable

public final class CallEventType
extends java.lang.Object
implements java.io.Serializable

Defines a specific call event report type. EVENT HANDLING RULES: The following general event handling rules apply to dynamically armed events: When requesting events for one leg: When the monitor mode is set to P_CALL_MONITOR_MODE_DO_NOT_MONITOR all events armed for that event type are disarmed. The additionalEventCriteria are not taken into account. When requesting two events for the same event type with different criteria and/or different monitor mode the last used criteria and monitor mode apply. Events that are not applicable to a leg are refused with exception P_INVALID_EVENT_TYPE. The same exception is used when criteria are used that are not applicable to the leg, For example requesting P_CALL_EVENT_TERMINATING_SERVICE_CODE on an originating leg is refused with exception P_INVALID_CRITERIA. When P_CALL_EVENT_ORIGINATING_RELEASE is requested with P_BUSY in the criteria the request is refused with the same exception. When receiving events: If an armed event is met, then it is disarmed, unless explicit stated that it will not to be disarmed. If an event is met that causes the release of the related leg, then all events related to that leg are disarmed. When an event is met on a call leg irrespective of the event monitor mode, then only events belonging to that call leg may become disarmed (see table below). If a call is released, then all events related to that call are disarmed. NOTE 1: Event disarmed means monitor mode is set to DO_NOT_MONITOR. and event armed means monitor mode is set to INTERRUPT or NOTIFY.

See Also:
Serialized Form

Field Summary
static int _CALL_EVENT_ADDRESS_ANALYSED
          The destination address has been analysed.
static int _CALL_EVENT_ADDRESS_COLLECTED
          The destination address has been collected.
static int _CALL_EVENT_ALERTING
          Call is alerting at the call party.
static int _CALL_EVENT_ANSWER
          Call answered at address.
static int _CALL_EVENT_ORIGINATING_CALL_ATTEMPT
          An originating call attempt takes place (for example Off-hook event).
static int _CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED
          An originating call attempt is authorised
static int _CALL_EVENT_ORIGINATING_RELEASE
          A originating call/call leg is released
static int _CALL_EVENT_ORIGINATING_SERVICE_CODE
          Mid-call originating service code received.
static int _CALL_EVENT_QUEUED
          The Call Event has been queued.
static int _CALL_EVENT_REDIRECTED
          Call redirected to new address: an indication from the network that the call has been redirected to a new address (no events disarmed as a result of this).
static int _CALL_EVENT_TERMINATING_CALL_ATTEMPT
          A terminating call attempt takes place
static int _CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED
          A terminating call is authorized
static int _CALL_EVENT_TERMINATING_RELEASE
          A terminating call leg has been released or the call could not be routed.
static int _CALL_EVENT_TERMINATING_SERVICE_CODE
          Mid call terminating service code received.
static int _CALL_EVENT_UNDEFINED
          Undefined
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ADDRESS_ANALYSED
          The destination address has been analysed.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ADDRESS_COLLECTED
          The destination address has been collected.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ALERTING
          Call is alerting at the call party.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ANSWER
          Call answered at address.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_CALL_ATTEMPT
          An originating call attempt takes place (for example Off-hook event).
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED
          An originating call attempt is authorised
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_RELEASE
          A originating call/call leg is released
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_SERVICE_CODE
          Mid-call originating service code received.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_QUEUED
          The Call Event has been queued.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_REDIRECTED
          Call redirected to new address: an indication from the network that the call has been redirected to a new address (no events disarmed as a result of this).
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_CALL_ATTEMPT
          A terminating call attempt takes place
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED
          A terminating call is authorized
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_RELEASE
          A terminating call leg has been released or the call could not be routed.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_SERVICE_CODE
          Mid call terminating service code received.
static org.csapi.jr.se.cc.CallEventType CALL_EVENT_UNDEFINED
          Undefined
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
static org.csapi.jr.se.cc.CallEventType getObject(int value)
          Accepts values in the range of 0 to 14
 int getValue()
          Number representing enum type
 java.lang.String getValueText()
          getValueText method, overrides the getValueText() method in class java.lang.Object
 int hashCode()
          Returns a hashcode value for the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_CALL_EVENT_UNDEFINED

public static final int _CALL_EVENT_UNDEFINED
Undefined

See Also:
Constant Field Values

CALL_EVENT_UNDEFINED

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_UNDEFINED
Undefined


_CALL_EVENT_ORIGINATING_CALL_ATTEMPT

public static final int _CALL_EVENT_ORIGINATING_CALL_ATTEMPT
An originating call attempt takes place (for example Off-hook event).

See Also:
Constant Field Values

CALL_EVENT_ORIGINATING_CALL_ATTEMPT

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_CALL_ATTEMPT
An originating call attempt takes place (for example Off-hook event).


_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED

public static final int _CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED
An originating call attempt is authorised

See Also:
Constant Field Values

CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED
An originating call attempt is authorised


_CALL_EVENT_ADDRESS_COLLECTED

public static final int _CALL_EVENT_ADDRESS_COLLECTED
The destination address has been collected.

See Also:
Constant Field Values

CALL_EVENT_ADDRESS_COLLECTED

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ADDRESS_COLLECTED
The destination address has been collected.


_CALL_EVENT_ADDRESS_ANALYSED

public static final int _CALL_EVENT_ADDRESS_ANALYSED
The destination address has been analysed.

See Also:
Constant Field Values

CALL_EVENT_ADDRESS_ANALYSED

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ADDRESS_ANALYSED
The destination address has been analysed.


_CALL_EVENT_ORIGINATING_SERVICE_CODE

public static final int _CALL_EVENT_ORIGINATING_SERVICE_CODE
Mid-call originating service code received.

See Also:
Constant Field Values

CALL_EVENT_ORIGINATING_SERVICE_CODE

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_SERVICE_CODE
Mid-call originating service code received.


_CALL_EVENT_ORIGINATING_RELEASE

public static final int _CALL_EVENT_ORIGINATING_RELEASE
A originating call/call leg is released

See Also:
Constant Field Values

CALL_EVENT_ORIGINATING_RELEASE

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ORIGINATING_RELEASE
A originating call/call leg is released


_CALL_EVENT_TERMINATING_CALL_ATTEMPT

public static final int _CALL_EVENT_TERMINATING_CALL_ATTEMPT
A terminating call attempt takes place

See Also:
Constant Field Values

CALL_EVENT_TERMINATING_CALL_ATTEMPT

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_CALL_ATTEMPT
A terminating call attempt takes place


_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED

public static final int _CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED
A terminating call is authorized

See Also:
Constant Field Values

CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED
A terminating call is authorized


_CALL_EVENT_ALERTING

public static final int _CALL_EVENT_ALERTING
Call is alerting at the call party.

See Also:
Constant Field Values

CALL_EVENT_ALERTING

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ALERTING
Call is alerting at the call party.


_CALL_EVENT_ANSWER

public static final int _CALL_EVENT_ANSWER
Call answered at address.

See Also:
Constant Field Values

CALL_EVENT_ANSWER

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_ANSWER
Call answered at address.


_CALL_EVENT_TERMINATING_RELEASE

public static final int _CALL_EVENT_TERMINATING_RELEASE
A terminating call leg has been released or the call could not be routed.

See Also:
Constant Field Values

CALL_EVENT_TERMINATING_RELEASE

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_RELEASE
A terminating call leg has been released or the call could not be routed.


_CALL_EVENT_REDIRECTED

public static final int _CALL_EVENT_REDIRECTED
Call redirected to new address: an indication from the network that the call has been redirected to a new address (no events disarmed as a result of this).

See Also:
Constant Field Values

CALL_EVENT_REDIRECTED

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_REDIRECTED
Call redirected to new address: an indication from the network that the call has been redirected to a new address (no events disarmed as a result of this).


_CALL_EVENT_TERMINATING_SERVICE_CODE

public static final int _CALL_EVENT_TERMINATING_SERVICE_CODE
Mid call terminating service code received.

See Also:
Constant Field Values

CALL_EVENT_TERMINATING_SERVICE_CODE

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_TERMINATING_SERVICE_CODE
Mid call terminating service code received.


_CALL_EVENT_QUEUED

public static final int _CALL_EVENT_QUEUED
The Call Event has been queued. (no events are disarmed as a result of this)

See Also:
Constant Field Values

CALL_EVENT_QUEUED

public static final org.csapi.jr.se.cc.CallEventType CALL_EVENT_QUEUED
The Call Event has been queued. (no events are disarmed as a result of this)

Method Detail

getValue

public int getValue()
Number representing enum type

Returns:
int number representing type of object, this is defined within the class

getValueText

public java.lang.String getValueText()
getValueText method, overrides the getValueText() method in class java.lang.Object

Returns:
String The stringified version of the CallEventType object

getObject

public static org.csapi.jr.se.cc.CallEventType getObject(int value)
                                                  throws InvalidEnumValueException
Accepts values in the range of 0 to 14

Parameters:
value - number representing type of object, this is defined within the class
Throws:
InvalidEnumValueException - thrown if invalid value is passed into method

equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object