ch.ecma.csta.binding
Class BridgedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Indicates that an appearance at a shared bridged device configuration has been placed into an inactive mode (that is, queued state). See Device Configuations for more details on shared bridged device configurations.

Common situations that generate this event include:

• When the first appearance in a shared bridged device configuration appearance connects into the call at the device (that is, AnswerCall) (manual and service request initiated), the other appearances enter the inactive mode.
• When the first appearance in a shared bridged device configuration leaves a call at the device and at least one appearance is still connected into the call. (that is, ClearConnection) (manual and service request initiated).
• When the first appearance in a shared bridged device configuration retrieves a call and the other appearances return to the inactive mode.

For an illustration of this event, see ECMA 269, section 17.2.1, Figure 17-30 "Bridged Event".

This event is caused by an appearance being placed into an inactive mode.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

BridgedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
SubjectDeviceID	getBridgedAppearance() Returns the value of field 'bridgedAppearance'.
ConnectionID	getBridgedConnection() Returns the value of field 'bridgedConnection'.
ConnectionInformation	getBridgedConnectionInfo() Returns the value of field 'bridgedConnectionInfo'.
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'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
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	setBridgedAppearance(SubjectDeviceID bridgedAppearance) Sets the value of field 'bridgedAppearance'.
void	setBridgedConnection(ConnectionID bridgedConnection) Sets the value of field 'bridgedConnection'.
void	setBridgedConnectionInfo(ConnectionInformation bridgedConnectionInfo) Sets the value of field 'bridgedConnectionInfo'.
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	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static BridgedEvent	unmarshalBridgedEvent(java.io.Reader reader) Method unmarshalBridgedEvent
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

BridgedEvent

public BridgedEvent()

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

getBridgedAppearance

public SubjectDeviceID getBridgedAppearance()

Returns the value of field 'bridgedAppearance'. The field 'bridgedAppearance' has the following description: Specifies the appearance which was placed in the inactive mode. Mandatory.

Returns:

SubjectDeviceID

getBridgedConnection

public ConnectionID getBridgedConnection()

Returns the value of field 'bridgedConnection'. The field 'bridgedConnection' has the following description: Specifies the connection of the appearance that was placed in the inactive mode. Mandatory.

Returns:

ConnectionID

getBridgedConnectionInfo

public ConnectionInformation getBridgedConnectionInfo()

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

Returns:

ConnectionInformation

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

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

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

setBridgedAppearance

public void setBridgedAppearance(SubjectDeviceID bridgedAppearance)

Sets the value of field 'bridgedAppearance'. The field 'bridgedAppearance' has the following description: Specifies the appearance which was placed in the inactive mode. Mandatory.

Parameters:

bridgedAppearance - the value of field 'bridgedAppearance'.

setBridgedConnection

public void setBridgedConnection(ConnectionID bridgedConnection)

Sets the value of field 'bridgedConnection'. The field 'bridgedConnection' has the following description: Specifies the connection of the appearance that was placed in the inactive mode. Mandatory.

Parameters:

bridgedConnection - the value of field 'bridgedConnection'.

setBridgedConnectionInfo

public void setBridgedConnectionInfo(ConnectionInformation bridgedConnectionInfo)

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

Parameters:

bridgedConnectionInfo - the value of field 'bridgedConnectionInfo'.

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

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalBridgedEvent

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

Method unmarshalBridgedEvent

Parameters:

reader -

Returns:

BridgedEvent

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