ch.ecma.csta.binding
Class SetSpeakerMute

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Sets the speaker mute status of a specified device. The Set Speaker Mute service allows a computing function to control the speaker mute status of the hookswitch components at a specified device. While a device's speaker is muted, no audio information is transmitted over the speaker.

The device-type or call-type monitoring event sequence is a SpeakerMuteEvent.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SetSpeakerMute()

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'.
java.lang.Boolean	getSpeakerMuteOn() Returns the value of field 'speakerMuteOn'.
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	setSpeakerMuteOn(java.lang.Boolean speakerMuteOn) Sets the value of field 'speakerMuteOn'.
static SetSpeakerMute	unmarshalSetSpeakerMute(java.io.Reader reader) Method unmarshalSetSpeakerMute
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

SetSpeakerMute

public SetSpeakerMute()

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 at the designated device on which to set the feature. 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

getSpeakerMuteOn

public java.lang.Boolean getSpeakerMuteOn()

Returns the value of field 'speakerMuteOn'. The field 'speakerMuteOn' has the following description: Specifies the speaker mute setting of a particular speaker at a device. Mandatory. The complete set of possible values is:

• FALSE - Mute is off (speaker is activated).
• TRUE - Mute is on (speaker is muted).

Returns:

Boolean

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 at the designated device on which to set the feature. 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'.

setSpeakerMuteOn

public void setSpeakerMuteOn(java.lang.Boolean speakerMuteOn)

Sets the value of field 'speakerMuteOn'. The field 'speakerMuteOn' has the following description: Specifies the speaker mute setting of a particular speaker at a device. Mandatory. The complete set of possible values is:

• FALSE - Mute is off (speaker is activated).
• TRUE - Mute is on (speaker is muted).

Parameters:

speakerMuteOn - the value of field 'speakerMuteOn'.

unmarshalSetSpeakerMute

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

Method unmarshalSetSpeakerMute

Parameters:

reader -

Returns:

SetSpeakerMute

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