ch.ecma.csta.binding
Class DeliveredEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that a call is being presented to a device in either the Ringing or Entering Distribution modes of the alerting state.

The supported parameters for the DeliveredEvent are:

DeliveredEvent Supported Parameters
monitorCrossRefID	Mandatory	Associates the event to an established monitor.
connection	Mandatory	Specifies the connection that is alerting.
alertingDevice	Mandatory	Specifies the device that is alerting.
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.
cause	Mandatory	Specifies the reason for the event.

EventCause values:

• CALLFORWARD: The call has been redirected via one of the following features:
• Send All Calls
• Cover All Calls
• Go to Cover active
• DeflectCall
• CALLFORWARDIMMEDIATE: The call has been redirected via the Call Forwarding feature.
• CALLFORWARDBUSY: The call has been redirected for one of the following reasons:
• Cover - principal busy
• Cover - all call appearance busy
• CALLFORWARDNOANSWER: The call has been redirected because no answer from cover.
• KEYOPERATION: Indicates that the event report occurred at a bridged device. This cause has higher precedence than the following two causes. Note this is added for completeness but bridging is not supported.
• NEWCALL: The call has not yet been redirected
• REDIRECTED: The call has been redirected.

CSTA Functional Requirements:

1. The DeliveredEvent should not be used to determine when a device is physically ringing. (The RingerStatusEvent should be used for this.)
2. Not supported as it applies to bridging.
3. When observing a call or a device in a call, and the call diverts from a device in the call, if the switching function does not provide the Diverted event for all devices in a call or for call-type monitors (as indicated through the capabilities exchange services option), the computing function will use the alertingDevice, calledDevice, lastRedirectionDevice, and cause parameters to properly track the progress of the call as the result of the redirection. See Tracking a Diverted Call for more information.
4. If there is more than one calling device (that is, a conference calling back to a device), then the originatingNIDConnection parameter will not be present.
5. Not supported. This product does not support the associatedCallingDevice, networkCallingDevice or associatedCalledDevice, networkCalledDevice for external incoming and outgoing calls respectively.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DeliveredEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
SubjectDeviceID	getAlertingDevice() Returns the value of field 'alertingDevice'.
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'.
ConnectionID	getConnection() Returns the value of field 'connection'.
ConnectionInformation	getConnectionInfo() Returns the value of field 'connectionInfo'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
DeviceHistory	getDeviceHistory() Returns the value of field 'deviceHistory'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
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	setAlertingDevice(SubjectDeviceID alertingDevice) Sets the value of field 'alertingDevice'.
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	setConnection(ConnectionID connection) Sets the value of field 'connection'.
void	setConnectionInfo(ConnectionInformation connectionInfo) Sets the value of field 'connectionInfo'.
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	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 DeliveredEvent	unmarshalDeliveredEvent(java.io.Reader reader) Method unmarshalDeliveredEvent
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

DeliveredEvent

public DeliveredEvent()

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

getAlertingDevice

public SubjectDeviceID getAlertingDevice()

Returns the value of field 'alertingDevice'. The field 'alertingDevice' has the following description: Specifies the device that is alerting. Mandatory.

Returns:

SubjectDeviceID

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

getConnection

public ConnectionID getConnection()

Returns the value of field 'connection'. The field 'connection' has the following description: Specifies the connection that is alerting. Mandatory.

Returns:

ConnectionID

getConnectionInfo

public ConnectionInformation getConnectionInfo()

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

Returns:

ConnectionInformation

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

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'. The field 'originatingNIDConnection' has the following description: Specifies the connection of the Network Interface Device (NID) that the call originated from. Optional.

If this parameter is supported, it will be provided if there is an originating NID associated with the call, otherwise it will not be provided. See Functional Implementation #4.

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

setAlertingDevice

public void setAlertingDevice(SubjectDeviceID alertingDevice)

Sets the value of field 'alertingDevice'. The field 'alertingDevice' has the following description: Specifies the device that is alerting. Mandatory.

Parameters:

alertingDevice - the value of field 'alertingDevice'.

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'.

setConnection

public void setConnection(ConnectionID connection)

Sets the value of field 'connection'. The field 'connection' has the following description: Specifies the connection that is alerting. Mandatory.

Parameters:

connection - the value of field 'connection'.

setConnectionInfo

public void setConnectionInfo(ConnectionInformation connectionInfo)

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

Parameters:

connectionInfo - the value of field 'connectionInfo'.

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'.

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'. The field 'originatingNIDConnection' has the following description: Specifies the connection of the Network Interface Device (NID) that the call originated from. Optional.

If this parameter is supported, it will be provided if there is an originating NID associated with the call, otherwise it will not be provided. See Functional Implementation #4.

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'.

unmarshalDeliveredEvent

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

Method unmarshalDeliveredEvent

Parameters:

reader -

Returns:

DeliveredEvent

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