ch.ecma.csta.binding
Class OriginatedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that a call is being attempted from a device. It implies that input activity for the call is complete and that a call (rather than a feature) has been requested.

The supported parameters for the OriginatedEvent are:

OriginatedEvent Supported Parameters
monitorCrossRefID	Mandatory	Associates the event to an established monitor.
originatedConnection	Mandatory	Specifies the connection at which the call originated.
callingDevice	Mandatory	Specifies the calling device.
calledDevice	Mandatory	Specifies the originally called 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:

• NORMAL: Indicates that the event report occurred at a bridged device. This cause has higher precedence than the following cause. Note that this will be added for completeness but that bridging is not supported.
• NEWCALL: The call has not yet been redirected

CSTA Functional Requirements:

1. This event will only be generated when the computing function has a device-type or call-type monitoring applied to a device that is initiating a call.
2. This event will only be generated on an incoming call from a device outside the switching sub-domain when the device is a Network Interface Device that can have monitoring applied to it.
3. 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

OriginatedEvent()

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'.
SubjectDeviceID	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'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
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	getOriginatedConnection() Returns the value of field 'originatedConnection'.
ConnectionInformation	getOriginatedConnectionInfo() Returns the value of field 'originatedConnectionInfo'.
DeviceID	getOriginatingDevice() Returns the value of field 'originatingDevice'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
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(SubjectDeviceID 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	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
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	setOriginatedConnection(ConnectionID originatedConnection) Sets the value of field 'originatedConnection'.
void	setOriginatedConnectionInfo(ConnectionInformation originatedConnectionInfo) Sets the value of field 'originatedConnectionInfo'.
void	setOriginatingDevice(DeviceID originatingDevice) Sets the value of field 'originatingDevice'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
static OriginatedEvent	unmarshalOriginatedEvent(java.io.Reader reader) Method unmarshalOriginatedEvent
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

OriginatedEvent

public OriginatedEvent()

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 SubjectDeviceID getCallingDevice()

Returns the value of field 'callingDevice'. The field 'callingDevice' has the following description: Specifies the calling device. Mandatory.

Returns:

SubjectDeviceID

getCause

public EventCause getCause()

Returns the value of field 'cause'.

Returns:

EventCause

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

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

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

getOriginatedConnection

public ConnectionID getOriginatedConnection()

Returns the value of field 'originatedConnection'. The field 'originatedConnection' has the following description: Specifies the connection at which the call originated. Mandatory.

Returns:

ConnectionID

getOriginatedConnectionInfo

public ConnectionInformation getOriginatedConnectionInfo()

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

Returns:

ConnectionInformation

getOriginatingDevice

public DeviceID getOriginatingDevice()

Returns the value of field 'originatingDevice'. The field 'originatingDevice' has the following description: Specifies the originating device. The originating device represents a device that originated a call in the switching subdomain on behalf of the calling device (for example, a group of stations). The originating device will not represent a Network Interface Device.

This parameter may be provided for external outgoing and internal calls when the originating device is different from the calling device.

This parameter will not be provided for external incoming calls or when the originating device is identical to the calling device.

Returns:

DeviceID

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

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(SubjectDeviceID callingDevice)

Sets the value of field 'callingDevice'. The field 'callingDevice' has the following description: Specifies the calling device. Mandatory.

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

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

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

setOriginatedConnection

public void setOriginatedConnection(ConnectionID originatedConnection)

Sets the value of field 'originatedConnection'. The field 'originatedConnection' has the following description: Specifies the connection at which the call originated. Mandatory.

Parameters:

originatedConnection - the value of field 'originatedConnection'.

setOriginatedConnectionInfo

public void setOriginatedConnectionInfo(ConnectionInformation originatedConnectionInfo)

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

Parameters:

originatedConnectionInfo - the value of field 'originatedConnectionInfo'.

setOriginatingDevice

public void setOriginatingDevice(DeviceID originatingDevice)

Sets the value of field 'originatingDevice'. The field 'originatingDevice' has the following description: Specifies the originating device. The originating device represents a device that originated a call in the switching subdomain on behalf of the calling device (for example, a group of stations). The originating device will not represent a Network Interface Device.

This parameter may be provided for external outgoing and internal calls when the originating device is different from the calling device.

This parameter will not be provided for external incoming calls or when the originating device is identical to the calling device.

Parameters:

originatingDevice - the value of field 'originatingDevice'.

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

unmarshalOriginatedEvent

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

Method unmarshalOriginatedEvent

Parameters:

reader -

Returns:

OriginatedEvent

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