ch.ecma.csta.binding
Class SetMicrophoneMute

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Sets the microphone mute status of a specified device. While a device's microphone is muted, no audio information is transmitted over the microphone. This is used when it is desired to prevent the other device(s) in a call from hearing a conversation.

The monitoring event sequence is a MicrophoneMuteEvent for both device-type and call-type monitoring.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SetMicrophoneMute()

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	getMicrophoneMuteOn() Returns the value of field 'microphoneMuteOn'.
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	setMicrophoneMuteOn(java.lang.Boolean microphoneMuteOn) Sets the value of field 'microphoneMuteOn'.
static SetMicrophoneMute	unmarshalSetMicrophoneMute(java.io.Reader reader) Method unmarshalSetMicrophoneMute
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

SetMicrophoneMute

public SetMicrophoneMute()

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

getMicrophoneMuteOn

public java.lang.Boolean getMicrophoneMuteOn()

Returns the value of field 'microphoneMuteOn'. The field 'microphoneMuteOn' has the following description: Specifies the microphone mute setting of a particular microphone. Mandatory.

The complete set of possible values is:

• OFF - Microphone is activated.
• ON - Microphone 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'.

setMicrophoneMuteOn

public void setMicrophoneMuteOn(java.lang.Boolean microphoneMuteOn)

Sets the value of field 'microphoneMuteOn'. The field 'microphoneMuteOn' has the following description: Specifies the microphone mute setting of a particular microphone. Mandatory.

The complete set of possible values is:

• OFF - Microphone is activated.
• ON - Microphone is muted.

Parameters:

microphoneMuteOn - the value of field 'microphoneMuteOn'

unmarshalSetMicrophoneMute

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

Method unmarshalSetMicrophoneMute

Parameters:

reader -

Returns:

SetMicrophoneMute

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