ch.ecma.csta.binding
Class RetrievedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that a previously held call has been retrieved.

The supported parameters for the RetrievedEvent are:

RetrievedEvent Supported Parameters
monitorCrossRefID	Mandatory	Associates the event to an established monitor.
retrievedConnection	Mandatory	Specifies the connection at which the hold was deactivated.
retrievingDevice	Mandatory	Specifies the device at which the hold was deactivated.
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 two causes. Note this is added for completeness but bridging is not supported.

CSTA Functional Requirements:

1. This event is only generated for the Alternate feature when the device is alternating between a connection that is in the Connected state and a connection that is in the Hold state. Note that this event will not be generated when the Alternate feature is used to answer an alerting call (the EstablishedEvent is generated in this case). Refer to ECMA 269, Section 17.1.2, Alternate Call for more information.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

RetrievedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
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'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
ConnectionID	getRetrievedConnection() Returns the value of field 'retrievedConnection'.
ConnectionInformation	getRetrievedConnectionInfo() Returns the value of field 'retrievedConnectionInfo'.
SubjectDeviceID	getRetrievingDevice() Returns the value of field 'retrievingDevice'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
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	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	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setRetrievedConnection(ConnectionID retrievedConnection) Sets the value of field 'retrievedConnection'.
void	setRetrievedConnectionInfo(ConnectionInformation retrievedConnectionInfo) Sets the value of field 'retrievedConnectionInfo'.
void	setRetrievingDevice(SubjectDeviceID retrievingDevice) Sets the value of field 'retrievingDevice'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
static RetrievedEvent	unmarshalRetrievedEvent(java.io.Reader reader) Method unmarshalRetrievedEvent
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

RetrievedEvent

public RetrievedEvent()

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

getCallLinkageData

public CallLinkageData getCallLinkageData()

Returns the value of field 'callLinkageData'.

Returns:

CallLinkageData

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

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getRetrievedConnection

public ConnectionID getRetrievedConnection()

Returns the value of field 'retrievedConnection'. The field 'retrievedConnection' has the following description: Specifies the connection at which hold was deactivated. Mandatory.

Returns:

ConnectionID

getRetrievedConnectionInfo

public ConnectionInformation getRetrievedConnectionInfo()

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

Returns:

ConnectionInformation

getRetrievingDevice

public SubjectDeviceID getRetrievingDevice()

Returns the value of field 'retrievingDevice'. The field 'retrievingDevice' has the following description: Specifies the device at which hold was deactivated. Mandatory.

Returns:

SubjectDeviceID

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

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

setCallLinkageData

public void setCallLinkageData(CallLinkageData callLinkageData)

Sets the value of field 'callLinkageData'.

Parameters:

callLinkageData - the value of field 'callLinkageData'.

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

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setRetrievedConnection

public void setRetrievedConnection(ConnectionID retrievedConnection)

Sets the value of field 'retrievedConnection'. The field 'retrievedConnection' has the following description: Specifies the connection at which hold was deactivated. Mandatory.

Parameters:

retrievedConnection - the value of field 'retrievedConnection'.

setRetrievedConnectionInfo

public void setRetrievedConnectionInfo(ConnectionInformation retrievedConnectionInfo)

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

Parameters:

retrievedConnectionInfo - the value of field 'retrievedConnectionInfo'.

setRetrievingDevice

public void setRetrievingDevice(SubjectDeviceID retrievingDevice)

Sets the value of field 'retrievingDevice'. The field 'retrievingDevice' has the following description: Specifies the device at which hold was deactivated. Mandatory.

Parameters:

retrievingDevice - the value of field 'retrievingDevice'

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

unmarshalRetrievedEvent

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

Method unmarshalRetrievedEvent

Parameters:

reader -

Returns:

RetrievedEvent

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