ch.ecma.csta.binding
Class FailedEvent

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.FailedEvent

All Implemented Interfaces:

java.io.Serializable

public class FailedEvent
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Indicates that a call cannot be completed and/or a connection has entered the Fail state.

The supported parameters for the FailedEvent are:

FailedEvent Supported Parameters
monitorCrossRefID	Mandatory	Associates the event to an established monitor.
failedConnection	Mandatory	Specifies the connection that failed. (See Functional Requirement #3 at the end of this section.)
failingDevice	Mandatory	Specifies the device that failed.
callingDevice	Mandatory	Specifies the calling device.
calledDevice	Mandatory	Specifies the originally called device.
lastRedirectionDevice	Mandatory	Specifies the previously known redirected from device
localConnectionInfo	Conditional	Specifies the local connection state of the device associated with the Monitor Cross Reference ID. The following are the states of the devices in the call. For the failing device: Fail For the other devices left in the call: (unaffected) This parameter is mandatory for events generated for device-type monitors and otherwise shall not be provided.
cause	Mandatory	Specifies the reason for the event.

EventCause values:

• BUSY: User is busy or queue is full.
• CALLNOTANSWERED: User is not responding.
• TRUNKSBUSY: No trunks are available.
• RESOURCESNOTAVAILABLE: Call cannot be completed due to switching resources limitation; for example, no circuit or channel is available.
• REORDERTONE: Call is rejected or outgoing call is barred.
• DESTNOTOBTAINABLE: Invalid destination number.
• NETWORKNOTOBTAINABLE: Bearer capability is not available.
• INCOMPATIBLEDESTINATION: Incompatible destination number. For example, a call from a voice station to a data extension.
• CAPACITYOVERFLOW:
  • Queue full or for direct agent calls
  • The agent is not a member of the split or the agent is not logged in.

CSTA Functional Requirements:

1. Not supported as it applies to bridging.
2. Omitted as it applies to the Computing Function.
3. The content of the failedConnection parameter, depending on whether or not the Failed event is reported to the failing device's monitor, will contain one of the following types of connection identifiers (use the capabilities exchange services to determine which approach is supported by a particular switching function):
   1. A complete connection identifier (that is, an identifier that contains both a device identifier and call identifier). This indicates that a connection is made with the failing device, and that the Failed event will be reported to all active device-type monitors associated with the call, as well as all call-type monitors associated with the call.
   2. A call identifier only connection identifier (that is, an identifier that contains a valid call identifier and no device identifier). This indicates that a connection is not made with the failing device, and that the Failed event will only be reported to the active device and call-type monitors associated with the devices that were in the call prior to the failure (that is, if a device-type monitor was on the failing device, then the Failed event is not reported).
   3. A complete connection identifier (that is, an identifier that contains both a device identifier and call identifier), not being reported for monitors on the failing device. This indicates that the Failed event will only be reported to the active device and call-type monitors associated with the devices that were in the call prior to the failure (that is, if a device-type monitor was on the failing device, then the Failed event is not reported).
4. For external incoming calls, the contents of the networkCallingDeviceID and the networkCalledDeviceID parameters will not change as long as the associatedCallingDevice remains in the call. This differs from the callingDeviceID and the calledDeviceID parameters in that these parameters may change as a result of features such as transfer, forwarding, and conferencing, etc.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

FailedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
AssociatedCalledDeviceID	getAssociatedCalledDevice() Returns the value of field 'associatedCalledDevice'.
AssociatedCallingDeviceID	getAssociatedCallingDevice() Returns the value of field 'associatedCallingDevice'.
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
CalledDeviceID	getCalledDevice() Returns the value of field 'calledDevice'.
CallingDeviceID	getCallingDevice() Returns the value of field 'callingDevice'.
CallLinkageData	getCallLinkageData() Returns the value of field 'callLinkageData'.
EventCause	getCause() Returns the value of field 'cause'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
DeviceHistory	getDeviceHistory() Returns the value of field 'deviceHistory'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
ConnectionID	getFailedConnection() Returns the value of field 'failedConnection'.
ConnectionInformation	getFailedConnectionInfo() Returns the value of field 'failedConnectionInfo'.
SubjectDeviceID	getFailingDevice() Returns the value of field 'failingDevice'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
RedirectionDeviceID	getLastRedirectionDevice() Returns the value of field 'lastRedirectionDevice'.
LocalConnectionState	getLocalConnectionInfo() Returns the value of field 'localConnectionInfo'.
MediaCallCharacteristics	getMediaCallCharacteristics() Returns the value of field 'mediaCallCharacteristics'.
MessageInfo	getMessageInfo() Returns the value of field 'messageInfo'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
NetworkCalledDeviceID	getNetworkCalledDevice() Returns the value of field 'networkCalledDevice'.
NetworkCallingDeviceID	getNetworkCallingDevice() Returns the value of field 'networkCallingDevice'.
ConnectionID	getOriginatingNIDConnection() Returns the value of field 'originatingNIDConnection'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
UserData	getUserData() Returns the value of field 'userData'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setAssociatedCalledDevice(AssociatedCalledDeviceID associatedCalledDevice) Sets the value of field 'associatedCalledDevice'.
void	setAssociatedCallingDevice(AssociatedCallingDeviceID associatedCallingDevice) Sets the value of field 'associatedCallingDevice'.
void	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setCalledDevice(CalledDeviceID calledDevice) Sets the value of field 'calledDevice'.
void	setCallingDevice(CallingDeviceID callingDevice) Sets the value of field 'callingDevice'.
void	setCallLinkageData(CallLinkageData callLinkageData) Sets the value of field 'callLinkageData'.
void	setCause(EventCause cause) Sets the value of field 'cause'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setDeviceHistory(DeviceHistory deviceHistory) Sets the value of field 'deviceHistory'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setFailedConnection(ConnectionID failedConnection) Sets the value of field 'failedConnection'.
void	setFailedConnectionInfo(ConnectionInformation failedConnectionInfo) Sets the value of field 'failedConnectionInfo'.
void	setFailingDevice(SubjectDeviceID failingDevice) Sets the value of field 'failingDevice'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setLastRedirectionDevice(RedirectionDeviceID lastRedirectionDevice) Sets the value of field 'lastRedirectionDevice'.
void	setLocalConnectionInfo(LocalConnectionState localConnectionInfo) Sets the value of field 'localConnectionInfo'.
void	setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics) Sets the value of field 'mediaCallCharacteristics'.
void	setMessageInfo(MessageInfo messageInfo) Sets the value of field 'messageInfo'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setNetworkCalledDevice(NetworkCalledDeviceID networkCalledDevice) Sets the value of field 'networkCalledDevice'.
void	setNetworkCallingDevice(NetworkCallingDeviceID networkCallingDevice) Sets the value of field 'networkCallingDevice'.
void	setOriginatingNIDConnection(ConnectionID originatingNIDConnection) Sets the value of field 'originatingNIDConnection'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static FailedEvent	unmarshalFailedEvent(java.io.Reader reader) Method unmarshalFailedEvent
void	validate() Method validate

Methods inherited from class ch.ecma.csta.CastorObject

getOldSessionID, hashCode, setOldSessionID, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FailedEvent

public FailedEvent()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class ch.ecma.csta.CastorObject

Parameters:

obj -

Returns:

boolean

getAssociatedCalledDevice

public AssociatedCalledDeviceID getAssociatedCalledDevice()

Returns the value of field 'associatedCalledDevice'.

Returns:

AssociatedCalledDeviceID

getAssociatedCallingDevice

public AssociatedCallingDeviceID getAssociatedCallingDevice()

Returns the value of field 'associatedCallingDevice'.

Returns:

AssociatedCallingDeviceID

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()

Returns the value of field 'callCharacteristics'.

Returns:

CallCharacteristics

getCallLinkageData

public CallLinkageData getCallLinkageData()

Returns the value of field 'callLinkageData'.

Returns:

CallLinkageData

getCalledDevice

public CalledDeviceID getCalledDevice()

Returns the value of field 'calledDevice'.

Returns:

CalledDeviceID

getCallingDevice

public CallingDeviceID getCallingDevice()

Returns the value of field 'callingDevice'.

Returns:

CallingDeviceID

getCause

public EventCause getCause()

Returns the value of field 'cause'.

Returns:

EventCause

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getDeviceHistory

public DeviceHistory getDeviceHistory()

Returns the value of field 'deviceHistory'.

Returns:

DeviceHistory

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getFailedConnection

public ConnectionID getFailedConnection()

Returns the value of field 'failedConnection'. The field 'failedConnection' has the following description: Specifies the connection that failed. (See Functional Implementation #3.) Mandatory.

Returns:

ConnectionID

getFailedConnectionInfo

public ConnectionInformation getFailedConnectionInfo()

Returns the value of field 'failedConnectionInfo'. The field 'failedConnectionInfo' has the following description: Specifies the connection information associated with the failedConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Returns:

ConnectionInformation

getFailingDevice

public SubjectDeviceID getFailingDevice()

Returns the value of field 'failingDevice'. The field 'failingDevice' has the following description: Specifies the device that failed. Mandatory.

Returns:

SubjectDeviceID

getLanguagePreferences

public java.lang.String getLanguagePreferences()

Returns the value of field 'languagePreferences'.

Returns:

String

getLastRedirectionDevice

public RedirectionDeviceID getLastRedirectionDevice()

Returns the value of field 'lastRedirectionDevice'.

Returns:

RedirectionDeviceID

getLocalConnectionInfo

public LocalConnectionState getLocalConnectionInfo()

Returns the value of field 'localConnectionInfo'.

Returns:

LocalConnectionState

getMediaCallCharacteristics

public MediaCallCharacteristics getMediaCallCharacteristics()

Returns the value of field 'mediaCallCharacteristics'.

Returns:

MediaCallCharacteristics

getMessageInfo

public MessageInfo getMessageInfo()

Returns the value of field 'messageInfo'.

Returns:

MessageInfo

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getNetworkCalledDevice

public NetworkCalledDeviceID getNetworkCalledDevice()

Returns the value of field 'networkCalledDevice'.

Returns:

NetworkCalledDeviceID

getNetworkCallingDevice

public NetworkCallingDeviceID getNetworkCallingDevice()

Returns the value of field 'networkCallingDevice'.

Returns:

NetworkCallingDeviceID

getOriginatingNIDConnection

public ConnectionID getOriginatingNIDConnection()

Returns the value of field 'originatingNIDConnection'.

Returns:

ConnectionID

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

getSubjectOfCall

public java.lang.String getSubjectOfCall()

Returns the value of field 'subjectOfCall'.

Returns:

String

getUserData

public UserData getUserData()

Returns the value of field 'userData'.

Returns:

UserData

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

setAssociatedCalledDevice

public void setAssociatedCalledDevice(AssociatedCalledDeviceID associatedCalledDevice)

Sets the value of field 'associatedCalledDevice'.

Parameters:

associatedCalledDevice - the value of field 'associatedCalledDevice'.

setAssociatedCallingDevice

public void setAssociatedCallingDevice(AssociatedCallingDeviceID associatedCallingDevice)

Sets the value of field 'associatedCallingDevice'.

Parameters:

associatedCallingDevice - the value of field 'associatedCallingDevice'.

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setCallLinkageData

public void setCallLinkageData(CallLinkageData callLinkageData)

Sets the value of field 'callLinkageData'.

Parameters:

callLinkageData - the value of field 'callLinkageData'.

setCalledDevice

public void setCalledDevice(CalledDeviceID calledDevice)

Sets the value of field 'calledDevice'.

Parameters:

calledDevice - the value of field 'calledDevice'.

setCallingDevice

public void setCallingDevice(CallingDeviceID callingDevice)

Sets the value of field 'callingDevice'.

Parameters:

callingDevice - the value of field 'callingDevice'.

setCause

public void setCause(EventCause cause)

Sets the value of field 'cause'.

Parameters:

cause - the value of field 'cause'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setDeviceHistory

public void setDeviceHistory(DeviceHistory deviceHistory)

Sets the value of field 'deviceHistory'.

Parameters:

deviceHistory - the value of field 'deviceHistory'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setFailedConnection

public void setFailedConnection(ConnectionID failedConnection)

Sets the value of field 'failedConnection'. The field 'failedConnection' has the following description: Specifies the connection that failed. (See Functional Implementation #3.) Mandatory.

Parameters:

failedConnection - the value of field 'failedConnection'

setFailedConnectionInfo

public void setFailedConnectionInfo(ConnectionInformation failedConnectionInfo)

Sets the value of field 'failedConnectionInfo'. The field 'failedConnectionInfo' has the following description: Specifies the connection information associated with the failedConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Parameters:

failedConnectionInfo - the value of field 'failedConnectionInfo'.

setFailingDevice

public void setFailingDevice(SubjectDeviceID failingDevice)

Sets the value of field 'failingDevice'. The field 'failingDevice' has the following description: Specifies the device that failed. Mandatory.

Parameters:

failingDevice - the value of field 'failingDevice'.

setLanguagePreferences

public void setLanguagePreferences(java.lang.String languagePreferences)

Sets the value of field 'languagePreferences'.

Parameters:

languagePreferences - the value of field 'languagePreferences'.

setLastRedirectionDevice

public void setLastRedirectionDevice(RedirectionDeviceID lastRedirectionDevice)

Sets the value of field 'lastRedirectionDevice'.

Parameters:

lastRedirectionDevice - the value of field 'lastRedirectionDevice'.

setLocalConnectionInfo

public void setLocalConnectionInfo(LocalConnectionState localConnectionInfo)

Sets the value of field 'localConnectionInfo'.

Parameters:

localConnectionInfo - the value of field 'localConnectionInfo'.

setMediaCallCharacteristics

public void setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics)

Sets the value of field 'mediaCallCharacteristics'.

Parameters:

mediaCallCharacteristics - the value of field 'mediaCallCharacteristics'.

setMessageInfo

public void setMessageInfo(MessageInfo messageInfo)

Sets the value of field 'messageInfo'.

Parameters:

messageInfo - the value of field 'messageInfo'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setNetworkCalledDevice

public void setNetworkCalledDevice(NetworkCalledDeviceID networkCalledDevice)

Sets the value of field 'networkCalledDevice'.

Parameters:

networkCalledDevice - the value of field 'networkCalledDevice'.

setNetworkCallingDevice

public void setNetworkCallingDevice(NetworkCallingDeviceID networkCallingDevice)

Sets the value of field 'networkCallingDevice'.

Parameters:

networkCallingDevice - the value of field 'networkCallingDevice'.

setOriginatingNIDConnection

public void setOriginatingNIDConnection(ConnectionID originatingNIDConnection)

Sets the value of field 'originatingNIDConnection'.

Parameters:

originatingNIDConnection - the value of field 'originatingNIDConnection'.

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

setSubjectOfCall

public void setSubjectOfCall(java.lang.String subjectOfCall)

Sets the value of field 'subjectOfCall'.

Parameters:

subjectOfCall - the value of field 'subjectOfCall'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalFailedEvent

public static FailedEvent unmarshalFailedEvent(java.io.Reader reader)
                                        throws org.exolab.castor.xml.MarshalException,
                                               org.exolab.castor.xml.ValidationException

Method unmarshalFailedEvent

Parameters:

reader -

Returns:

FailedEvent

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException