ch.ecma.csta.binding
Class MediaAttachedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not supported.

Indicates that a media service instance has been attached to a call. This event may be generated as a result of a previous AttachMediaService service request, or as a result of an automatic media service attachment.

Refer to the specification of the call control services(s) and resulting call control events(s) associated with the specified connectionMode for a description of the operational model.

CSTA Functional Implementation:

1. If a media access device was added to the call as a result of a successful Attach Media Service service request, then the mediaConnection and mediaDevice parameters refer to the media access device. If the media service instance was directly bound to an existing connection in the call, then the mediaConnection and mediaDevice parameters refer to the connection at that attaching device.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MediaAttachedEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
LocalConnectionState	getLocalConnectionInfo() Returns the value of field 'localConnectionInfo'.
MediaCallCharacteristics	getMediaCallCharacteristics() Returns the value of field 'mediaCallCharacteristics'.
ConnectionID	getMediaConnection() Returns the value of field 'mediaConnection'.
ConnectionInformation	getMediaConnectionInfo() Returns the value of field 'mediaConnectionInfo'.
SubjectDeviceID	getMediaDevice() Returns the value of field 'mediaDevice'.
java.lang.String	getMediaServiceInstanceID() Returns the value of field 'mediaServiceInstanceID'.
MediaServiceType	getMediaServiceType() Returns the value of field 'mediaServiceType'.
java.lang.Long	getMediaServiceVersion() Returns the value of field 'mediaServiceVersion'.
java.lang.String	getMediaStreamID() Returns the value of field 'mediaStreamID'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
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	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLocalConnectionInfo(LocalConnectionState localConnectionInfo) Sets the value of field 'localConnectionInfo'.
void	setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics) Sets the value of field 'mediaCallCharacteristics'.
void	setMediaConnection(ConnectionID mediaConnection) Sets the value of field 'mediaConnection'.
void	setMediaConnectionInfo(ConnectionInformation mediaConnectionInfo) Sets the value of field 'mediaConnectionInfo'.
void	setMediaDevice(SubjectDeviceID mediaDevice) Sets the value of field 'mediaDevice'.
void	setMediaServiceInstanceID(java.lang.String mediaServiceInstanceID) Sets the value of field 'mediaServiceInstanceID'.
void	setMediaServiceType(MediaServiceType mediaServiceType) Sets the value of field 'mediaServiceType'.
void	setMediaServiceVersion(java.lang.Long mediaServiceVersion) Sets the value of field 'mediaServiceVersion'.
void	setMediaStreamID(java.lang.String mediaStreamID) Sets the value of field 'mediaStreamID'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
static MediaAttachedEvent	unmarshalMediaAttachedEvent(java.io.Reader reader) Method unmarshalMediaAttachedEvent
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

MediaAttachedEvent

public MediaAttachedEvent()

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

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getLocalConnectionInfo

public LocalConnectionState getLocalConnectionInfo()

Returns the value of field 'localConnectionInfo'.

Returns:

LocalConnectionState

getMediaCallCharacteristics

public MediaCallCharacteristics getMediaCallCharacteristics()

Returns the value of field 'mediaCallCharacteristics'.

Returns:

MediaCallCharacteristics

getMediaConnection

public ConnectionID getMediaConnection()

Returns the value of field 'mediaConnection'. The field 'mediaConnection' has the following description: Specifies the connection that was bound to the media service. Mandatory

Returns:

ConnectionID

getMediaConnectionInfo

public ConnectionInformation getMediaConnectionInfo()

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

Returns:

ConnectionInformation

getMediaDevice

public SubjectDeviceID getMediaDevice()

Returns the value of field 'mediaDevice'. The field 'mediaDevice' has the following description: Specifies the device identifier associated with the attached media service. Mandatory.

Returns:

SubjectDeviceID

getMediaServiceInstanceID

public java.lang.String getMediaServiceInstanceID()

Returns the value of field 'mediaServiceInstanceID'. The field 'mediaServiceInstanceID' has the following description: Specifies the media service instance associated with the attached media service. Optional.

Returns:

String

getMediaServiceType

public MediaServiceType getMediaServiceType()

Returns the value of field 'mediaServiceType'. The field 'mediaServiceType' has the following description: Specifies the media service type. Mandatory.

Returns:

MediaServiceType

getMediaServiceVersion

public java.lang.Long getMediaServiceVersion()

Returns the value of field 'mediaServiceVersion'. The field 'mediaServiceVersion' has the following description: Specifies the version of the media services. Optional.

Returns:

Long

getMediaStreamID

public java.lang.String getMediaStreamID()

Returns the value of field 'mediaStreamID'. The field 'mediaStreamID' has the following description: Specifies the Media stream ID used to access the media service. This parameter will be provided if the switching function supports providing the mediaStreamID as indicated by the capability exchange services.

Returns:

String

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

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

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

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

setMediaConnection

public void setMediaConnection(ConnectionID mediaConnection)

Sets the value of field 'mediaConnection'. The field 'mediaConnection' has the following description: Specifies the connection that was bound to the media service. Mandatory

Parameters:

mediaConnection - the value of field 'mediaConnection'.

setMediaConnectionInfo

public void setMediaConnectionInfo(ConnectionInformation mediaConnectionInfo)

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

Parameters:

mediaConnectionInfo - the value of field 'mediaConnectionInfo'.

setMediaDevice

public void setMediaDevice(SubjectDeviceID mediaDevice)

Sets the value of field 'mediaDevice'. The field 'mediaDevice' has the following description: Specifies the device identifier associated with the attached media service. Mandatory.

Parameters:

mediaDevice - the value of field 'mediaDevice'.

setMediaServiceInstanceID

public void setMediaServiceInstanceID(java.lang.String mediaServiceInstanceID)

Sets the value of field 'mediaServiceInstanceID'. The field 'mediaServiceInstanceID' has the following description: Specifies the media service instance associated with the attached media service. Optional.

Parameters:

mediaServiceInstanceID - the value of field 'mediaServiceInstanceID'.

setMediaServiceType

public void setMediaServiceType(MediaServiceType mediaServiceType)

Sets the value of field 'mediaServiceType'. The field 'mediaServiceType' has the following description: Specifies the media service type. Mandatory.

Parameters:

mediaServiceType - the value of field 'mediaServiceType'

setMediaServiceVersion

public void setMediaServiceVersion(java.lang.Long mediaServiceVersion)

Sets the value of field 'mediaServiceVersion'. The field 'mediaServiceVersion' has the following description: Specifies the version of the media services. Optional.

Parameters:

mediaServiceVersion - the value of field 'mediaServiceVersion'.

setMediaStreamID

public void setMediaStreamID(java.lang.String mediaStreamID)

Sets the value of field 'mediaStreamID'. The field 'mediaStreamID' has the following description: Specifies the Media stream ID used to access the media service. This parameter will be provided if the switching function supports providing the mediaStreamID as indicated by the capability exchange services.

Parameters:

mediaStreamID - the value of field 'mediaStreamID'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalMediaAttachedEvent

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

Method unmarshalMediaAttachedEvent

Parameters:

reader -

Returns:

MediaAttachedEvent

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