4.1.0.610 20071213

ch.ecma.csta.binding
Class SetVoiceAttribute

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by ch.ecma.csta.binding.SetVoiceAttribute
All Implemented Interfaces:
java.io.Serializable

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

This request is not supported.

Sets a voice attribute for a specified connection and message. The voice attributes that can be set include playing speed, playing volume, and recording gain.

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

CSTA Functional Requirements:

  1. This service can only be used to set one attribute per service request. If multiple attributes need to be set for the same message, multiple service requests will be used.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
SetVoiceAttribute()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 AttributeToSet getAttributeToSet()
          Returns the value of field 'attributeToSet'.
 ConnectionID getConnection()
          Returns the value of field 'connection'.
 CSTACommonArguments getExtensions()
          Returns the value of field 'extensions'.
 java.lang.String getMessage()
          Returns the value of field 'message'.
 java.lang.String getResource()
          Returns the value of field 'resource'.
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 void setAttributeToSet(AttributeToSet attributeToSet)
          Sets the value of field 'attributeToSet'.
 void setConnection(ConnectionID connection)
          Sets the value of field 'connection'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
 void setMessage(java.lang.String message)
          Sets the value of field 'message'.
 void setResource(java.lang.String resource)
          Sets the value of field 'resource'.
static SetVoiceAttribute unmarshalSetVoiceAttribute(java.io.Reader reader)
          Method unmarshalSetVoiceAttribute
 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

SetVoiceAttribute

public SetVoiceAttribute()
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

getAttributeToSet

public AttributeToSet getAttributeToSet()
Returns the value of field 'attributeToSet'. The field 'attributeToSet' has the following description: Specifies the attribute to be set. Mandatory.

This will be one of the following choices:

Returns:
AttributeToSet

getConnection

public ConnectionID getConnection()
Returns the value of field 'connection'. The field 'connection' has the following description: Specifies the Connection on which the voice attribute should be set. Mandatory.

Returns:
ConnectionID

getExtensions

public CSTACommonArguments getExtensions()
Returns the value of field 'extensions'.

Returns:
CSTACommonArguments

getMessage

public java.lang.String getMessage()
Returns the value of field 'message'. The field 'message' has the following description: Specifies the message whose voice attribute is to be set. This parameter is mandatory if there are multiple active messages on the specified connection, otherwise the parameter is optional.

If this parameter is not provided, the service applies to the currently active message on the specified connection.

Returns:
String

getResource

public java.lang.String getResource()
Returns the value of field 'resource'.

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

setAttributeToSet

public void setAttributeToSet(AttributeToSet attributeToSet)
Sets the value of field 'attributeToSet'. The field 'attributeToSet' has the following description: Specifies the attribute to be set. Mandatory.

This will be one of the following choices:

Parameters:
attributeToSet - the value of field 'attributeToSet'.

setConnection

public void setConnection(ConnectionID connection)
Sets the value of field 'connection'. The field 'connection' has the following description: Specifies the Connection on which the voice attribute should be set. Mandatory.

Parameters:
connection - the value of field 'connection'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)
Sets the value of field 'extensions'.

Parameters:
extensions - the value of field 'extensions'.

setMessage

public void setMessage(java.lang.String message)
Sets the value of field 'message'. The field 'message' has the following description: Specifies the message whose voice attribute is to be set. This parameter is mandatory if there are multiple active messages on the specified connection, otherwise the parameter is optional.

If this parameter is not provided, the service applies to the currently active message on the specified connection.

Parameters:
message - the value of field 'message'.

setResource

public void setResource(java.lang.String resource)
Sets the value of field 'resource'.

Parameters:
resource - the value of field 'resource'.

unmarshalSetVoiceAttribute

public static SetVoiceAttribute unmarshalSetVoiceAttribute(java.io.Reader reader)
                                                    throws org.exolab.castor.xml.MarshalException,
                                                           org.exolab.castor.xml.ValidationException
Method unmarshalSetVoiceAttribute

Parameters:
reader -
Returns:
SetVoiceAttribute
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

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.