ch.ecma.csta.binding
Class MicrophoneGainEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that the microphone gain setting has changed for one of the hookswitches.

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

• The microphone gain setting has been adjusted on the telephone.
• A computing function, on behalf of a user, has invoked the SetMicrophoneGain service.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MicrophoneGainEvent()

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'.
MicrophoneGain	getMicrophoneGain() Returns the value of field 'microphoneGain'.
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	setMicrophoneGain(MicrophoneGain microphoneGain) Sets the value of field 'microphoneGain'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
static MicrophoneGainEvent	unmarshalMicrophoneGainEvent(java.io.Reader reader) Method unmarshalMicrophoneGainEvent
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

MicrophoneGainEvent

public MicrophoneGainEvent()

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 microphone whose gain 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

getMicrophoneGain

public MicrophoneGain getMicrophoneGain()

Returns the value of field 'microphoneGain'. The field 'microphoneGain' has the following description: Specifies the gain as an absolute gain value or that the gain has been incremented or decremented by a switch specified increment. Mandatory.

It may be one of the following possible choices:

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

Returns:

MicrophoneGain

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 containing the microphone whose gain 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'.

setMicrophoneGain

public void setMicrophoneGain(MicrophoneGain microphoneGain)

Sets the value of field 'microphoneGain'. The field 'microphoneGain' has the following description: Specifies the gain as an absolute gain value or that the gain has been incremented or decremented by a switch specified increment. Mandatory.

It may be one of the following possible choices:

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

Parameters:

microphoneGain - the value of field 'microphoneGain'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalMicrophoneGainEvent

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

Method unmarshalMicrophoneGainEvent

Parameters:

reader -

Returns:

MicrophoneGainEvent

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