ch.ecma.csta.binding
Class SetRingerStatus

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Sets the specified ringer to ring or not to ring, to a particular ring pattern, and/or set the ring volume of a ringer at a specified device. This service allows the computing function to control ringing of a specified ringer on a device. It also allows a computing function to control the ring pattern and ring volume settings only during the ringing cycle that is being initiated with this service (that is, does not permanently change the configuration or programming of the ringer attributes). At least one of the following parameters in the service request described above will be provided in the service request:

• ring mode
• ring pattern
• ring volume

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

Note that some switching functions do not allow the computing function to directly control ringing of a device. (Switching functions will ring a device to indicate that a call has arrived at a device, for example.)

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SetRingerStatus()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
DeviceID	getDevice() Returns the value of field 'device'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getRinger() Returns the value of field 'ringer'.
RingMode	getRingMode() Returns the value of field 'ringMode'.
java.lang.Long	getRingPattern() Returns the value of field 'ringPattern'.
Volume	getRingVolume() Returns the value of field 'ringVolume'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setDevice(DeviceID device) Sets the value of field 'device'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setRinger(java.lang.String ringer) Sets the value of field 'ringer'.
void	setRingMode(RingMode ringMode) Sets the value of field 'ringMode'.
void	setRingPattern(java.lang.Long ringPattern) Sets the value of field 'ringPattern'.
void	setRingVolume(Volume ringVolume) Sets the value of field 'ringVolume'.
static SetRingerStatus	unmarshalSetRingerStatus(java.io.Reader reader) Method unmarshalSetRingerStatus
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

SetRingerStatus

public SetRingerStatus()

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

getDevice

public DeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Mandatory.

Returns:

DeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getRingMode

public RingMode getRingMode()

Returns the value of field 'ringMode'. The field 'ringMode' has the following description: Indicates if the ringer should be rung or not rung. Optional.

The complete set of possible values is:

• ringing - The ringer should be rung.
• not ringing - The ringer should not be rung.

Returns:

RingMode

getRingPattern

public java.lang.Long getRingPattern()

Returns the value of field 'ringPattern'. The field 'ringPattern' has the following description: Indicates the value of the ringing pattern of the ringer. The meaning of the ringing patterns and the number of supported patters is device specific. This parameter is only valid when ringMode has a value of ringing and has no effect on the ringPattern used during subsequent call related ringing.

If ringMode has a value of Ringing then ringPattern is Mandatory.

Returns:

Long

getRingVolume

public Volume getRingVolume()

Returns the value of field 'ringVolume'. The field 'ringVolume' has the following description: Indicates the volume level of the ringer. May specify either an absolute value or may specify that the volume should be incremented or decremented by a switch specified increment. Optional.

It may be one of the following possible choices:

• ringVolAbs (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
• ringVolInc (Enumerated) - Specifies if the volume is to be incremented or decremented by a switch specified amount. The complete set of possible values is:
  • increment - the volume is incremented
  • decrement - the volume is decremented.

Note that the relationship between the ringer volume and loudness is ringer specific.

Returns:

Volume

getRinger

public java.lang.String getRinger()

Returns the value of field 'ringer'. The field 'ringer' has the following description: Specifies the ringer to be set. Mandatory.

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

setDevice

public void setDevice(DeviceID device)

Sets the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Mandatory.

Parameters:

device - the value of field 'device'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setRingMode

public void setRingMode(RingMode ringMode)

Sets the value of field 'ringMode'. The field 'ringMode' has the following description: Indicates if the ringer should be rung or not rung. Optional.

The complete set of possible values is:

• ringing - The ringer should be rung.
• not ringing - The ringer should not be rung.

Parameters:

ringMode - the value of field 'ringMode'.

setRingPattern

public void setRingPattern(java.lang.Long ringPattern)

Sets the value of field 'ringPattern'. The field 'ringPattern' has the following description: Indicates the value of the ringing pattern of the ringer. The meaning of the ringing patterns and the number of supported patters is device specific. This parameter is only valid when ringMode has a value of ringing and has no effect on the ringPattern used during subsequent call related ringing.

If ringMode has a value of Ringing then ringPattern is Mandatory.

Parameters:

ringPattern - the value of field 'ringPattern'.

setRingVolume

public void setRingVolume(Volume ringVolume)

Sets the value of field 'ringVolume'. The field 'ringVolume' has the following description: Indicates the volume level of the ringer. May specify either an absolute value or may specify that the volume should be incremented or decremented by a switch specified increment. Optional.

It may be one of the following possible choices:

• ringVolAbs (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
• ringVolInc (Enumerated) - Specifies if the volume is to be incremented or decremented by a switch specified amount. The complete set of possible values is:
  • increment - the volume is incremented
  • decrement - the volume is decremented.

Note that the relationship between the ringer volume and loudness is ringer specific.

Parameters:

ringVolume - the value of field 'ringVolume'.

setRinger

public void setRinger(java.lang.String ringer)

Sets the value of field 'ringer'. The field 'ringer' has the following description: Specifies the ringer to be set. Mandatory.

Parameters:

ringer - the value of field 'ringer'.

unmarshalSetRingerStatus

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

Method unmarshalSetRingerStatus

Parameters:

reader -

Returns:

SetRingerStatus

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