ch.ecma.csta.binding
Class SetSpeakerVolume

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Sets the speaker volume setting of a specified device. The Set Speaker Volume service allows the computing function to control the speaker volume of the speaker associated with one auditory apparatus at a specified device.

The device-type and call-type monitoring event sequence is a SpeakerVolumeEvent.

CSTA Functional Requirements:

1. Some switching functions may reset the speaker volume after each call.
2. Some switching functions reject the setting of the speaker volume if there is not an active call at a device.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SetSpeakerVolume()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getAuditoryApparatus() Returns the value of field 'auditoryApparatus'.
DeviceID	getDevice() Returns the value of field 'device'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
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	setDevice(DeviceID device) Sets the value of field 'device'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setSpeakerVolume(Volume speakerVolume) Sets the value of field 'speakerVolume'.
static SetSpeakerVolume	unmarshalSetSpeakerVolume(java.io.Reader reader) Method unmarshalSetSpeakerVolume
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

SetSpeakerVolume

public SetSpeakerVolume()

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 is to be set. Mandatory.

Returns:

String

getDevice

public DeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Mandatory.

Returns:

DeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

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 should be incremented or decremented by a switch specified increment. Mandatory.

It may be one of the following possible choices:

• speakerVolAbs (Value) - Specifies a value from 0 through 100. 0 indicates silence, and 100 indicates maximum volume. The granularity and quantization of the values 1 though 99 are device specific.
• speakerVolInc (Enumerated) - Specifies if the volume is to be incremented or decremented by a switch specified amount. The complete set of possible values is:
  • increment - the volume is incremented.
  • decrement - the volume is decremented.

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 is to be set. Mandatory.

Parameters:

auditoryApparatus - the value of field 'auditoryApparatus'.

setDevice

public void setDevice(DeviceID device)

Sets the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Mandatory.

Parameters:

device - the value of field 'device'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

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 should be incremented or decremented by a switch specified increment. Mandatory.

It may be one of the following possible choices:

• speakerVolAbs (Value) - Specifies a value from 0 through 100. 0 indicates silence, and 100 indicates maximum volume. The granularity and quantization of the values 1 though 99 are device specific.
• speakerVolInc (Enumerated) - Specifies if the volume is to be incremented or decremented by a switch specified amount. The complete set of possible values is:
  • increment - the volume is incremented.
  • decrement - the volume is decremented.

Parameters:

speakerVolume - the value of field 'speakerVolume'.

unmarshalSetSpeakerVolume

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

Method unmarshalSetSpeakerVolume

Parameters:

reader -

Returns:

SetSpeakerVolume

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