4.1.0.610 20071213

ch.ecma.csta.binding
Class ConnectionClearedEvent

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by ch.ecma.csta.binding.ConnectionClearedEvent
All Implemented Interfaces:
java.io.Serializable

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

Indicates that a device in a call has disconnected or dropped out from a call.

The supported parameters for the ConnectionClearedEvent are:

ConnectionClearedEvent Supported Parameters
monitorCrossRefID Mandatory Associates the event to an established monitor.
droppedConnection Mandatory Specifies the connection of the DeviceID that was dropped from the call.
releasingDevice Conditional Specifies the device that was dropped from the call.
cause Mandatory Specifies the reason for the event.

EventCause values:

CSTA Functional Requirements:

  1. Not supported as it applies to bridging.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
ConnectionClearedEvent()
           
 
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'.
 ChargingInfo getChargingInfo()
          Returns the value of field 'chargingInfo'.
 CorrelatorData getCorrelatorData()
          Returns the value of field 'correlatorData'.
 DeviceHistory getDeviceHistory()
          Returns the value of field 'deviceHistory'.
 ConnectionID getDroppedConnection()
          Returns the value of field 'droppedConnection'.
 ConnectionInformation getDroppedConnectionInfo()
          Returns the value of field 'droppedConnectionInfo'.
 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'.
 SubjectDeviceID getReleasingDevice()
          Returns the value of field 'releasingDevice'.
 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 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 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 setDroppedConnection(ConnectionID droppedConnection)
          Sets the value of field 'droppedConnection'.
 void setDroppedConnectionInfo(ConnectionInformation droppedConnectionInfo)
          Sets the value of field 'droppedConnectionInfo'.
 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 setReleasingDevice(SubjectDeviceID releasingDevice)
          Sets the value of field 'releasingDevice'.
 void setServicesPermitted(ServicesPermitted servicesPermitted)
          Sets the value of field 'servicesPermitted'.
 void setUserData(UserData userData)
          Sets the value of field 'userData'.
static ConnectionClearedEvent unmarshalConnectionClearedEvent(java.io.Reader reader)
          Method unmarshalConnectionClearedEvent
 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

ConnectionClearedEvent

public ConnectionClearedEvent()
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

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 dropped from 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

getDroppedConnection

public ConnectionID getDroppedConnection()
Returns the value of field 'droppedConnection'. The field 'droppedConnection' has the following description: Specifies the connection of the device that was dropped from the call. Mandatory.

Returns:
ConnectionID

getDroppedConnectionInfo

public ConnectionInformation getDroppedConnectionInfo()
Returns the value of field 'droppedConnectionInfo'. The field 'droppedConnectionInfo' has the following description: Specifies the connection information associated with the droppedConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Returns:
ConnectionInformation

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

getReleasingDevice

public SubjectDeviceID getReleasingDevice()
Returns the value of field 'releasingDevice'. The field 'releasingDevice' has the following description: Specifies the device that dropped from the call. Mandatory.

Returns:
SubjectDeviceID

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

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

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

setDroppedConnection

public void setDroppedConnection(ConnectionID droppedConnection)
Sets the value of field 'droppedConnection'. The field 'droppedConnection' has the following description: Specifies the connection of the device that was dropped from the call. Mandatory.

Parameters:
droppedConnection - the value of field 'droppedConnection'.

setDroppedConnectionInfo

public void setDroppedConnectionInfo(ConnectionInformation droppedConnectionInfo)
Sets the value of field 'droppedConnectionInfo'. The field 'droppedConnectionInfo' has the following description: Specifies the connection information associated with the droppedConnection connection. Optional. If this parameter is not present, then the connection information is switching function specific.

Parameters:
droppedConnectionInfo - the value of field 'droppedConnectionInfo'.

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

setReleasingDevice

public void setReleasingDevice(SubjectDeviceID releasingDevice)
Sets the value of field 'releasingDevice'. The field 'releasingDevice' has the following description: Specifies the device that dropped from the call. Mandatory.

Parameters:
releasingDevice - the value of field 'releasingDevice'.

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

unmarshalConnectionClearedEvent

public static ConnectionClearedEvent unmarshalConnectionClearedEvent(java.io.Reader reader)
                                                              throws org.exolab.castor.xml.MarshalException,
                                                                     org.exolab.castor.xml.ValidationException
Method unmarshalConnectionClearedEvent

Parameters:
reader -
Returns:
ConnectionClearedEvent
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

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.