ch.ecma.csta.binding
Class MicrophoneMuteEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that the microphone mute status has changed for one of the hookswitches.

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

• The microphone mute feature has been invoked manually on the telephone.
• A computing function, on behalf of a user, has invoked the SetMicrophoneMute service.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MicrophoneMuteEvent()

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.Boolean	getMicrophoneMuteOn() Returns the value of field 'microphoneMuteOn'.
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	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	setMicrophoneMuteOn(java.lang.Boolean microphoneMuteOn) Sets the value of field 'microphoneMuteOn'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
static MicrophoneMuteEvent	unmarshalMicrophoneMuteEvent(java.io.Reader reader) Method unmarshalMicrophoneMuteEvent
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

MicrophoneMuteEvent

public MicrophoneMuteEvent()

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 where the mute status was changed. Mandatory.

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

Returns:

SubjectDeviceID

getMicrophoneMuteOn

public java.lang.Boolean getMicrophoneMuteOn()

Returns the value of field 'microphoneMuteOn'. The field 'microphoneMuteOn' has the following description: Specifies whether the microphone is muted or not. Mandatory.

The complete set of possible values is:

• FALSE - Microphone is activated.
• TRUE - Microphone is muted.

Returns:

Boolean

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

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 where the mute status was changed. Mandatory.

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

Parameters:

invokingDevice - the value of field 'invokingDevice'.

setMicrophoneMuteOn

public void setMicrophoneMuteOn(java.lang.Boolean microphoneMuteOn)

Sets the value of field 'microphoneMuteOn'. The field 'microphoneMuteOn' has the following description: Specifies whether the microphone is muted or not. Mandatory.

The complete set of possible values is:

• FALSE - Microphone is activated.
• TRUE - Microphone is muted.

Parameters:

microphoneMuteOn - the value of field 'microphoneMuteOn'

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalMicrophoneMuteEvent

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

Method unmarshalMicrophoneMuteEvent

Parameters:

reader -

Returns:

MicrophoneMuteEvent

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