ch.ecma.csta.binding
Class TransferedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that an existing call has been transferred to another device and that the device transferring the call has been dropped from the call. The transferring device does not appear in any future events for the call.

The supported parameters for the TransferedEvent are:

TransferedEvent Supported Parameters
monitorCrossRefID	Mandatory	Associates the event to an established monitor.
primaryOldCall	Mandatory	Specifies the connection of the primary call.
secondaryOldCall	Mandatory	Specifies the connection of the secondary call.
transferringDevice	Mandatory	Specifies the device that transferred the call.
transferredToDevice	Mandatory	Specifies the transferred to device.
transferredConnections	Mandatory	Specifies information on each device/ConnectionID in the resulting transferred call. Each list item is of type ConnectionListItem.
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:

• TRANSFER: Call transfer has occurred.
• NORMAL: A call transfer was performed for parking a call rather than a true call transfer operation.

EventCause values:

• TRANSFER: Call transfer has occurred.
• NORMAL: A call transfer was performed for parking a call rather than a true call transfer operation.

CSTA Functional Requirements:

1. [AVAYA QUALIFIED] According to ECMA 269, the contents of the primaryOldCall and the secondaryOldCall parameters may contain either a "fixed view" or a "local view" of the connections at a device before the transfer has been completed. This product supports fixed view as defined below.
   
   • fixed view - for each transferred event generated by monitors placed on different devices in a call, the switching function provides the same information in the primaryOldCall and the secondaryOldCall parameters independent of the monitorType (call or device-type monitor) and independent of the role of the device in the conference (conferencingDevice, addedParty, etc.). The meaning of these parameters for the fixed-view are:
     • primaryOldCall - specifies the first call visible at the transferringDevice.
     • secondaryOldCall - specifies the second call visible at the transferringDevice.
2. The transferredConnections parameter is a list that contains the new ConnectionID, old ConnectionID, DeviceID (values such as ANI, etc.), and for externally located devices the associated Network Interface DeviceID. Refer to Connection List), for a description of which components are optional and mandatory.
3. Omitted as it applies to the Computing Function.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

TransferedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
CallLinkageDataList	getCallLinkageDataList() Returns the value of field 'callLinkageDataList'.
EventCause	getCause() Returns the value of field 'cause'.
ChargingInfo	getChargingInfo() Returns the value of field 'chargingInfo'.
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'.
LocalConnectionState	getLocalConnectionInfo() Returns the value of field 'localConnectionInfo'.
MediaCallCharacteristics	getMediaCallCharacteristics() Returns the value of field 'mediaCallCharacteristics'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
ConnectionID	getPrimaryOldCall() Returns the value of field 'primaryOldCall'.
ConnectionID	getSecondaryOldCall() Returns the value of field 'secondaryOldCall'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
ConnectionList	getTransferredConnections() Returns the value of field 'transferredConnections'.
SubjectDeviceID	getTransferredToDevice() Returns the value of field 'transferredToDevice'.
SubjectDeviceID	getTransferringDevice() Returns the value of field 'transferringDevice'.
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	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setCallLinkageDataList(CallLinkageDataList callLinkageDataList) Sets the value of field 'callLinkageDataList'.
void	setCause(EventCause cause) Sets the value of field 'cause'.
void	setChargingInfo(ChargingInfo chargingInfo) Sets the value of field 'chargingInfo'.
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	setLocalConnectionInfo(LocalConnectionState localConnectionInfo) Sets the value of field 'localConnectionInfo'.
void	setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics) Sets the value of field 'mediaCallCharacteristics'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setPrimaryOldCall(ConnectionID primaryOldCall) Sets the value of field 'primaryOldCall'.
void	setSecondaryOldCall(ConnectionID secondaryOldCall) Sets the value of field 'secondaryOldCall'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setTransferredConnections(ConnectionList transferredConnections) Sets the value of field 'transferredConnections'.
void	setTransferredToDevice(SubjectDeviceID transferredToDevice) Sets the value of field 'transferredToDevice'.
void	setTransferringDevice(SubjectDeviceID transferringDevice) Sets the value of field 'transferringDevice'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static TransferedEvent	unmarshalTransferedEvent(java.io.Reader reader) Method unmarshalTransferedEvent
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

TransferedEvent

public TransferedEvent()

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

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()

Returns the value of field 'callCharacteristics'.

Returns:

CallCharacteristics

getCallLinkageDataList

public CallLinkageDataList getCallLinkageDataList()

Returns the value of field 'callLinkageDataList'. The field 'callLinkageDataList' has the following description: Specifies the global call data and thread data associated with the call. This parameter is mandatory if the switching function supports the call linkage feature otherwise it will not be provided.

The parameter consists of the following components:

• newCallLinkageData (M) CallLinkageData - specifies the call linkage data associated with the resulting call.
• oldCallLinkageData (M) CallLinkageData - specifies the call linkage data that was discarded as the result of the transfer.

Returns:

CallLinkageDataList

getCause

public EventCause getCause()

Returns the value of field 'cause'.

Returns:

EventCause

getChargingInfo

public ChargingInfo getChargingInfo()

Returns the value of field 'chargingInfo'. The field 'chargingInfo' has the following description: Specifies a total value of charging or currency units for the device that transferred the call. Optional.

Returns:

ChargingInfo

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

getLocalConnectionInfo

public LocalConnectionState getLocalConnectionInfo()

Returns the value of field 'localConnectionInfo'.

Returns:

LocalConnectionState

getMediaCallCharacteristics

public MediaCallCharacteristics getMediaCallCharacteristics()

Returns the value of field 'mediaCallCharacteristics'.

Returns:

MediaCallCharacteristics

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getPrimaryOldCall

public ConnectionID getPrimaryOldCall()

Returns the value of field 'primaryOldCall'. The field 'primaryOldCall' has the following description: Specifies the connection of the primary call. Mandatory.

See CSTA Functional Requirements #1.

Returns:

ConnectionID

getSecondaryOldCall

public ConnectionID getSecondaryOldCall()

Returns the value of field 'secondaryOldCall'. The field 'secondaryOldCall' has the following description: Specifies the connection of the secondary call. If the switching function supports the "fixed-view" option (as indicated by the capability exchange services), this parameter is mandatory.

If the switching function supports the "local-view" option, this parameter is mandatory if there are two known calls involved with the transfer (before the transfer is created) from the perspective of the monitored device, otherwise it will not be provided.

See CSTA Functional Requirements #1.

Returns:

ConnectionID

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

getTransferredConnections

public ConnectionList getTransferredConnections()

Returns the value of field 'transferredConnections'. The field 'transferredConnections' has the following description: Specifies information on each device/ConnectionID in the resulting transferred call that are known by the switching function. Mandatory.

Returns:

ConnectionList

getTransferredToDevice

public SubjectDeviceID getTransferredToDevice()

Returns the value of field 'transferredToDevice'. The field 'transferredToDevice' has the following description: Specifies the transferred to device. Mandatory.

Returns:

SubjectDeviceID

getTransferringDevice

public SubjectDeviceID getTransferringDevice()

Returns the value of field 'transferringDevice'. The field 'transferringDevice' has the following description: Specifies the device that transferred the call. Mandatory.

Returns:

SubjectDeviceID

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

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setCallLinkageDataList

public void setCallLinkageDataList(CallLinkageDataList callLinkageDataList)

Sets the value of field 'callLinkageDataList'. The field 'callLinkageDataList' has the following description: Specifies the global call data and thread data associated with the call. This parameter is mandatory if the switching function supports the call linkage feature otherwise it will not be provided.

The parameter consists of the following components:

• newCallLinkageData (M) CallLinkageData - specifies the call linkage data associated with the resulting call.
• oldCallLinkageData (M) CallLinkageData - specifies the call linkage data that was discarded as the result of the transfer.

Parameters:

callLinkageDataList - the value of field 'callLinkageDataList'.

setCause

public void setCause(EventCause cause)

Sets the value of field 'cause'.

Parameters:

cause - the value of field 'cause'.

setChargingInfo

public void setChargingInfo(ChargingInfo chargingInfo)

Sets the value of field 'chargingInfo'. The field 'chargingInfo' has the following description: Specifies a total value of charging or currency units for the device that transferred the call. Optional.

Parameters:

chargingInfo - the value of field 'chargingInfo'.

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

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

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setPrimaryOldCall

public void setPrimaryOldCall(ConnectionID primaryOldCall)

Sets the value of field 'primaryOldCall'. The field 'primaryOldCall' has the following description: Specifies the connection of the primary call. Mandatory.

See CSTA Functional Requirements #1.

Parameters:

primaryOldCall - the value of field 'primaryOldCall'.

setSecondaryOldCall

public void setSecondaryOldCall(ConnectionID secondaryOldCall)

Sets the value of field 'secondaryOldCall'. The field 'secondaryOldCall' has the following description: Specifies the connection of the secondary call. If the switching function supports the "fixed-view" option (as indicated by the capability exchange services), this parameter is mandatory.

If the switching function supports the "local-view" option, this parameter is mandatory if there are two known calls involved with the transfer (before the transfer is created) from the perspective of the monitored device, otherwise it will not be provided.

See CSTA Functional Requirements #1.

Parameters:

secondaryOldCall - the value of field 'secondaryOldCall'

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

setTransferredConnections

public void setTransferredConnections(ConnectionList transferredConnections)

Sets the value of field 'transferredConnections'. The field 'transferredConnections' has the following description: Specifies information on each device/ConnectionID in the resulting transferred call that are known by the switching function. Mandatory.

Parameters:

transferredConnections - the value of field 'transferredConnections'.

setTransferredToDevice

public void setTransferredToDevice(SubjectDeviceID transferredToDevice)

Sets the value of field 'transferredToDevice'. The field 'transferredToDevice' has the following description: Specifies the transferred to device. Mandatory.

Parameters:

transferredToDevice - the value of field 'transferredToDevice'.

setTransferringDevice

public void setTransferringDevice(SubjectDeviceID transferringDevice)

Sets the value of field 'transferringDevice'. The field 'transferringDevice' has the following description: Specifies the device that transferred the call. Mandatory.

Parameters:

transferringDevice - the value of field 'transferringDevice'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalTransferedEvent

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

Method unmarshalTransferedEvent

Parameters:

reader -

Returns:

TransferedEvent

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