ch.ecma.csta.binding
Class SpeakerMuteEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates the speaker mute status has changed for one of the hookswitches.

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

• The Speaker Mute feature has been invoked manually on the telephone.
• The computing function has invoked the SetSpeakerMute service.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SpeakerMuteEvent()

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

SpeakerMuteEvent

public SpeakerMuteEvent()

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 mute status has 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

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getSpeakerMuteOn

public java.lang.Boolean getSpeakerMuteOn()

Returns the value of field 'speakerMuteOn'. The field 'speakerMuteOn' has the following description: Specifies whether the speaker mute setting is on or not. 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 containing the speaker whose mute status has 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'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setSpeakerMuteOn

public void setSpeakerMuteOn(java.lang.Boolean speakerMuteOn)

Sets the value of field 'speakerMuteOn'. The field 'speakerMuteOn' has the following description: Specifies whether the speaker mute setting is on or not. 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'.

unmarshalSpeakerMuteEvent

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

Method unmarshalSpeakerMuteEvent

Parameters:

reader -

Returns:

SpeakerMuteEvent

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