ch.ecma.csta.binding
Class VoiceAttributeChangedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Not implemented.

Indicates that one or more attributes of a message have changed. This event is caused by a voice attribute of a message having changed. (a more specific cause cannot be provided).

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

VoiceAttributeChangedEvent()

Method Summary

void	addVoiceAttributeChangedEventGrammars(int index, VoiceAttributeChangedEventGrammars vVoiceAttributeChangedEventGrammars) Method addVoiceAttributeChangedEventGrammars
void	addVoiceAttributeChangedEventGrammars(VoiceAttributeChangedEventGrammars vVoiceAttributeChangedEventGrammars) Method addVoiceAttributeChangedEventGrammars
java.util.Enumeration	enumerateVoiceAttributeChangedEventGrammars() Method enumerateVoiceAttributeChangedEventGrammars
boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.Boolean	getAutoInterruptible() Returns the value of field 'autoInterruptible'.
java.lang.Float	getBabbleTimeout() Returns the value of field 'babbleTimeout'.
EventCause	getCause() Returns the value of field 'cause'.
ConnectionID	getConnection() Returns the value of field 'connection'.
java.lang.Long	getCurrentPosition() Returns the value of field 'currentPosition'.
java.lang.Float	getEndSilence() Returns the value of field 'endSilence'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.Float	getInterdigitTimeout() Returns the value of field 'interdigitTimeout'.
java.lang.String	getLanguage() Returns the value of field 'language'.
java.lang.Float	getMaxTimeout() Returns the value of field 'maxTimeout'.
java.lang.String	getMessage() Returns the value of field 'message'.
ModeType	getMode() Returns the value of field 'mode'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
Volume	getPlayVolume() Returns the value of field 'playVolume'.
java.lang.Boolean	getPreflush() Returns the value of field 'preflush'.
java.lang.Integer	getRecordingGain() Returns the value of field 'recordingGain'.
java.lang.Float	getRejectionThreshold() Returns the value of field 'rejectionThreshold'.
java.lang.String	getResource() Returns the value of field 'resource'.
java.lang.Boolean	getRetainAudio() Returns the value of field 'retainAudio'.
ServicesPermitted	getServicesPermitted() Returns the value of field 'servicesPermitted'.
java.lang.Float	getSilenceTimeout() Returns the value of field 'silenceTimeout'.
java.lang.Long	getSpeed() Returns the value of field 'speed'.
VoiceAttributeChangedEventGrammars[]	getVoiceAttributeChangedEventGrammars() Method getVoiceAttributeChangedEventGrammars
VoiceAttributeChangedEventGrammars	getVoiceAttributeChangedEventGrammars(int index) Method getVoiceAttributeChangedEventGrammars
int	getVoiceAttributeChangedEventGrammarsCount() Method getVoiceAttributeChangedEventGrammarsCount
VoiceAttributeChangedEventInnerXml	getVoiceAttributeChangedEventInnerXml() Returns the value of field 'voiceAttributeChangedEventInnerXml'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	removeAllVoiceAttributeChangedEventGrammars() Method removeAllVoiceAttributeChangedEventGrammars
VoiceAttributeChangedEventGrammars	removeVoiceAttributeChangedEventGrammars(int index) Method removeVoiceAttributeChangedEventGrammars
void	setAutoInterruptible(java.lang.Boolean autoInterruptible) Sets the value of field 'autoInterruptible'.
void	setBabbleTimeout(java.lang.Float babbleTimeout) Sets the value of field 'babbleTimeout'.
void	setCause(EventCause cause) Sets the value of field 'cause'.
void	setConnection(ConnectionID connection) Sets the value of field 'connection'.
void	setCurrentPosition(java.lang.Long currentPosition) Sets the value of field 'currentPosition'.
void	setEndSilence(java.lang.Float endSilence) Sets the value of field 'endSilence'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setInterdigitTimeout(java.lang.Float interdigitTimeout) Sets the value of field 'interdigitTimeout'.
void	setLanguage(java.lang.String language) Sets the value of field 'language'.
void	setMaxTimeout(java.lang.Float maxTimeout) Sets the value of field 'maxTimeout'.
void	setMessage(java.lang.String message) Sets the value of field 'message'.
void	setMode(ModeType mode) Sets the value of field 'mode'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setPlayVolume(Volume playVolume) Sets the value of field 'playVolume'.
void	setPreflush(java.lang.Boolean preflush) Sets the value of field 'preflush'.
void	setRecordingGain(java.lang.Integer recordingGain) Sets the value of field 'recordingGain'.
void	setRejectionThreshold(java.lang.Float rejectionThreshold) Sets the value of field 'rejectionThreshold'.
void	setResource(java.lang.String resource) Sets the value of field 'resource'.
void	setRetainAudio(java.lang.Boolean retainAudio) Sets the value of field 'retainAudio'.
void	setServicesPermitted(ServicesPermitted servicesPermitted) Sets the value of field 'servicesPermitted'.
void	setSilenceTimeout(java.lang.Float silenceTimeout) Sets the value of field 'silenceTimeout'.
void	setSpeed(java.lang.Long speed) Sets the value of field 'speed'.
void	setVoiceAttributeChangedEventGrammars(int index, VoiceAttributeChangedEventGrammars vVoiceAttributeChangedEventGrammars) Method setVoiceAttributeChangedEventGrammars
void	setVoiceAttributeChangedEventGrammars(VoiceAttributeChangedEventGrammars[] voiceAttributeChangedEventGrammarsArray) Method setVoiceAttributeChangedEventGrammars
void	setVoiceAttributeChangedEventInnerXml(VoiceAttributeChangedEventInnerXml voiceAttributeChangedEventInnerXml) Sets the value of field 'voiceAttributeChangedEventInnerXml'.
static VoiceAttributeChangedEvent	unmarshalVoiceAttributeChangedEvent(java.io.Reader reader) Method unmarshalVoiceAttributeChangedEvent
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

VoiceAttributeChangedEvent

public VoiceAttributeChangedEvent()

Method Detail

addVoiceAttributeChangedEventGrammars

public void addVoiceAttributeChangedEventGrammars(VoiceAttributeChangedEventGrammars vVoiceAttributeChangedEventGrammars)
                                           throws java.lang.IndexOutOfBoundsException

Method addVoiceAttributeChangedEventGrammars

Parameters:

vVoiceAttributeChangedEventGrammars -

Throws:

java.lang.IndexOutOfBoundsException

addVoiceAttributeChangedEventGrammars

public void addVoiceAttributeChangedEventGrammars(int index,
                                                  VoiceAttributeChangedEventGrammars vVoiceAttributeChangedEventGrammars)
                                           throws java.lang.IndexOutOfBoundsException

Method addVoiceAttributeChangedEventGrammars

Parameters:

index -

vVoiceAttributeChangedEventGrammars -

Throws:

java.lang.IndexOutOfBoundsException

enumerateVoiceAttributeChangedEventGrammars

public java.util.Enumeration enumerateVoiceAttributeChangedEventGrammars()

Method enumerateVoiceAttributeChangedEventGrammars

Returns:

Enumeration

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

getAutoInterruptible

public java.lang.Boolean getAutoInterruptible()

Returns the value of field 'autoInterruptible'.

Returns:

Boolean

getBabbleTimeout

public java.lang.Float getBabbleTimeout()

Returns the value of field 'babbleTimeout'.

Returns:

Float

getCause

public EventCause getCause()

Returns the value of field 'cause'.

Returns:

EventCause

getConnection

public ConnectionID getConnection()

Returns the value of field 'connection'. The field 'connection' has the following description: Indicates the connection for the message whose attribute has changed. Mandatory.

Returns:

ConnectionID

getCurrentPosition

public java.lang.Long getCurrentPosition()

Returns the value of field 'currentPosition'. The field 'currentPosition' has the following description: Indicates the number of milliseconds from the start of the message. Optional.

Returns:

Long

getEndSilence

public java.lang.Float getEndSilence()

Returns the value of field 'endSilence'.

Returns:

Float

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getInterdigitTimeout

public java.lang.Float getInterdigitTimeout()

Returns the value of field 'interdigitTimeout'.

Returns:

Float

getLanguage

public java.lang.String getLanguage()

Returns the value of field 'language'.

Returns:

String

getMaxTimeout

public java.lang.Float getMaxTimeout()

Returns the value of field 'maxTimeout'.

Returns:

Float

getMessage

public java.lang.String getMessage()

Returns the value of field 'message'. The field 'message' has the following description: Indicates the message that has changed. Mandatory.

Returns:

String

getMode

public ModeType getMode()

Returns the value of field 'mode'.

Returns:

ModeType

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getPlayVolume

public Volume getPlayVolume()

Returns the value of field 'playVolume'. The field 'playVolume' has the following description: Indicates the current play volume as an absolute value or that the volume was incremented or decremented by a switch specified increment. Optional.

It may be one of the following possible choices:

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

Returns:

Volume

getPreflush

public java.lang.Boolean getPreflush()

Returns the value of field 'preflush'.

Returns:

Boolean

getRecordingGain

public java.lang.Integer getRecordingGain()

Returns the value of field 'recordingGain'. The field 'recordingGain' has the following description: Indicates the current recording level (100 indicating maximum gain and 0 indicating minimum gain). Optional.

Returns:

Integer

getRejectionThreshold

public java.lang.Float getRejectionThreshold()

Returns the value of field 'rejectionThreshold'.

Returns:

Float

getResource

public java.lang.String getResource()

Returns the value of field 'resource'.

Returns:

String

getRetainAudio

public java.lang.Boolean getRetainAudio()

Returns the value of field 'retainAudio'.

Returns:

Boolean

getServicesPermitted

public ServicesPermitted getServicesPermitted()

Returns the value of field 'servicesPermitted'.

Returns:

ServicesPermitted

getSilenceTimeout

public java.lang.Float getSilenceTimeout()

Returns the value of field 'silenceTimeout'.

Returns:

Float

getSpeed

public java.lang.Long getSpeed()

Returns the value of field 'speed'. The field 'speed' has the following description: Indicates the current playing speed of the message (represents the percentage of normal speed, with 100% being normal speed and the slowest reportable speed being 1%)

Returns:

Long

getVoiceAttributeChangedEventGrammars

public VoiceAttributeChangedEventGrammars getVoiceAttributeChangedEventGrammars(int index)
                                                                         throws java.lang.IndexOutOfBoundsException

Method getVoiceAttributeChangedEventGrammars

Parameters:

index -

Returns:

VoiceAttributeChangedEventGrammars

Throws:

java.lang.IndexOutOfBoundsException

getVoiceAttributeChangedEventGrammars

public VoiceAttributeChangedEventGrammars[] getVoiceAttributeChangedEventGrammars()

Method getVoiceAttributeChangedEventGrammars

Returns:

VoiceAttributeChangedEventGrammars

getVoiceAttributeChangedEventGrammarsCount

public int getVoiceAttributeChangedEventGrammarsCount()

Method getVoiceAttributeChangedEventGrammarsCount

Returns:

int

getVoiceAttributeChangedEventInnerXml

public VoiceAttributeChangedEventInnerXml getVoiceAttributeChangedEventInnerXml()

Returns the value of field 'voiceAttributeChangedEventInnerXml'.

Returns:

VoiceAttributeChangedEventInnerXml

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

removeAllVoiceAttributeChangedEventGrammars

public void removeAllVoiceAttributeChangedEventGrammars()

Method removeAllVoiceAttributeChangedEventGrammars

removeVoiceAttributeChangedEventGrammars

public VoiceAttributeChangedEventGrammars removeVoiceAttributeChangedEventGrammars(int index)

Method removeVoiceAttributeChangedEventGrammars

Parameters:

index -

Returns:

VoiceAttributeChangedEventGrammars

setAutoInterruptible

public void setAutoInterruptible(java.lang.Boolean autoInterruptible)

Sets the value of field 'autoInterruptible'.

Parameters:

autoInterruptible - the value of field 'autoInterruptible'.

setBabbleTimeout

public void setBabbleTimeout(java.lang.Float babbleTimeout)

Sets the value of field 'babbleTimeout'.

Parameters:

babbleTimeout - the value of field 'babbleTimeout'.

setCause

public void setCause(EventCause cause)

Sets the value of field 'cause'.

Parameters:

cause - the value of field 'cause'.

setConnection

public void setConnection(ConnectionID connection)

Sets the value of field 'connection'. The field 'connection' has the following description: Indicates the connection for the message whose attribute has changed. Mandatory.

Parameters:

connection - the value of field 'connection'.

setCurrentPosition

public void setCurrentPosition(java.lang.Long currentPosition)

Sets the value of field 'currentPosition'. The field 'currentPosition' has the following description: Indicates the number of milliseconds from the start of the message. Optional.

Parameters:

currentPosition - the value of field 'currentPosition'.

setEndSilence

public void setEndSilence(java.lang.Float endSilence)

Sets the value of field 'endSilence'.

Parameters:

endSilence - the value of field 'endSilence'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setInterdigitTimeout

public void setInterdigitTimeout(java.lang.Float interdigitTimeout)

Sets the value of field 'interdigitTimeout'.

Parameters:

interdigitTimeout - the value of field 'interdigitTimeout'.

setLanguage

public void setLanguage(java.lang.String language)

Sets the value of field 'language'.

Parameters:

language - the value of field 'language'.

setMaxTimeout

public void setMaxTimeout(java.lang.Float maxTimeout)

Sets the value of field 'maxTimeout'.

Parameters:

maxTimeout - the value of field 'maxTimeout'.

setMessage

public void setMessage(java.lang.String message)

Sets the value of field 'message'. The field 'message' has the following description: Indicates the message that has changed. Mandatory.

Parameters:

message - the value of field 'message'.

setMode

public void setMode(ModeType mode)

Sets the value of field 'mode'.

Parameters:

mode - the value of field 'mode'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setPlayVolume

public void setPlayVolume(Volume playVolume)

Sets the value of field 'playVolume'. The field 'playVolume' has the following description: Indicates the current play volume as an absolute value or that the volume was incremented or decremented by a switch specified increment. Optional.

It may be one of the following possible choices:

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

Parameters:

playVolume - the value of field 'playVolume'.

setPreflush

public void setPreflush(java.lang.Boolean preflush)

Sets the value of field 'preflush'.

Parameters:

preflush - the value of field 'preflush'.

setRecordingGain

public void setRecordingGain(java.lang.Integer recordingGain)

Sets the value of field 'recordingGain'. The field 'recordingGain' has the following description: Indicates the current recording level (100 indicating maximum gain and 0 indicating minimum gain). Optional.

Parameters:

recordingGain - the value of field 'recordingGain'.

setRejectionThreshold

public void setRejectionThreshold(java.lang.Float rejectionThreshold)

Sets the value of field 'rejectionThreshold'.

Parameters:

rejectionThreshold - the value of field 'rejectionThreshold'.

setResource

public void setResource(java.lang.String resource)

Sets the value of field 'resource'.

Parameters:

resource - the value of field 'resource'.

setRetainAudio

public void setRetainAudio(java.lang.Boolean retainAudio)

Sets the value of field 'retainAudio'.

Parameters:

retainAudio - the value of field 'retainAudio'.

setServicesPermitted

public void setServicesPermitted(ServicesPermitted servicesPermitted)

Sets the value of field 'servicesPermitted'.

Parameters:

servicesPermitted - the value of field 'servicesPermitted'.

setSilenceTimeout

public void setSilenceTimeout(java.lang.Float silenceTimeout)

Sets the value of field 'silenceTimeout'.

Parameters:

silenceTimeout - the value of field 'silenceTimeout'.

setSpeed

public void setSpeed(java.lang.Long speed)

Sets the value of field 'speed'. The field 'speed' has the following description: Indicates the current playing speed of the message (represents the percentage of normal speed, with 100% being normal speed and the slowest reportable speed being 1%)

Parameters:

speed - the value of field 'speed'.

setVoiceAttributeChangedEventGrammars

public void setVoiceAttributeChangedEventGrammars(int index,
                                                  VoiceAttributeChangedEventGrammars vVoiceAttributeChangedEventGrammars)
                                           throws java.lang.IndexOutOfBoundsException

Method setVoiceAttributeChangedEventGrammars

Parameters:

index -

vVoiceAttributeChangedEventGrammars -

Throws:

java.lang.IndexOutOfBoundsException

setVoiceAttributeChangedEventGrammars

public void setVoiceAttributeChangedEventGrammars(VoiceAttributeChangedEventGrammars[] voiceAttributeChangedEventGrammarsArray)

Method setVoiceAttributeChangedEventGrammars

Parameters:

voiceAttributeChangedEventGrammarsArray -

setVoiceAttributeChangedEventInnerXml

public void setVoiceAttributeChangedEventInnerXml(VoiceAttributeChangedEventInnerXml voiceAttributeChangedEventInnerXml)

Sets the value of field 'voiceAttributeChangedEventInnerXml'.

Parameters:

voiceAttributeChangedEventInnerXml - the value of field 'voiceAttributeChangedEventInnerXml'.

unmarshalVoiceAttributeChangedEvent

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

Method unmarshalVoiceAttributeChangedEvent

Parameters:

reader -

Returns:

VoiceAttributeChangedEvent

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