ch.ecma.csta.binding
Class SpeakerVolumeEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that the speaker volume setting has changed for one of the hookswitches.

This event may be generated in any one of the following ways:

• The speaker volume feature has been invoked manually on the telephone.
• The computing function has invoked the SetSpeakerVolume service.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SpeakerVolumeEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getAuditoryApparatus() Returns the value of field 'auditoryApparatus'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
SubjectDeviceID	getInvokingDevice() Returns the value of field 'invokingDevice'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
Volume	getSpeakerVolume() Returns the value of field 'speakerVolume'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setAuditoryApparatus(java.lang.String auditoryApparatus) Sets the value of field 'auditoryApparatus'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setInvokingDevice(SubjectDeviceID invokingDevice) Sets the value of field 'invokingDevice'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setSpeakerVolume(Volume speakerVolume) Sets the value of field 'speakerVolume'.
static SpeakerVolumeEvent	unmarshalSpeakerVolumeEvent(java.io.Reader reader) Method unmarshalSpeakerVolumeEvent
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

SpeakerVolumeEvent

public SpeakerVolumeEvent()

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

getAuditoryApparatus

public java.lang.String getAuditoryApparatus()

Returns the value of field 'auditoryApparatus'. The field 'auditoryApparatus' has the following description: Specifies the auditory apparatus containing the speaker whose volume has changed.

Returns:

String

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getInvokingDevice

public SubjectDeviceID getInvokingDevice()

Returns the value of field 'invokingDevice'. The field 'invokingDevice' has the following description: Specifies the device where the feature was invoked.

Returns:

SubjectDeviceID

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getSpeakerVolume

public Volume getSpeakerVolume()

Returns the value of field 'speakerVolume'. The field 'speakerVolume' has the following description: Specifies the speaker volume as an absolute value or that the volume was incremented or decremented by a switch specified increment.

Returns:

Volume

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

setAuditoryApparatus

public void setAuditoryApparatus(java.lang.String auditoryApparatus)

Sets the value of field 'auditoryApparatus'. The field 'auditoryApparatus' has the following description: Specifies the auditory apparatus containing the speaker whose volume has changed.

Parameters:

auditoryApparatus - the value of field 'auditoryApparatus'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setInvokingDevice

public void setInvokingDevice(SubjectDeviceID invokingDevice)

Sets the value of field 'invokingDevice'. The field 'invokingDevice' has the following description: Specifies the device where the feature was invoked.

Parameters:

invokingDevice - the value of field 'invokingDevice'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setSpeakerVolume

public void setSpeakerVolume(Volume speakerVolume)

Sets the value of field 'speakerVolume'. The field 'speakerVolume' has the following description: Specifies the speaker volume as an absolute value or that the volume was incremented or decremented by a switch specified increment.

Parameters:

speakerVolume - the value of field 'speakerVolume'.

unmarshalSpeakerVolumeEvent

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

Method unmarshalSpeakerVolumeEvent

Parameters:

reader -

Returns:

SpeakerVolumeEvent

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