ch.ecma.csta.binding
Class GetRingerStatus

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

All Implemented Interfaces:

java.io.Serializable

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

Gets the ringer status (ringing/not ringing, ring count, ring pattern, ring volume) of one or all ringers associated with a device. This allows a computing function to determine:

• if a ringer is engaged in a ringing cycle
• the number of ring cycles that it has been ringing
• the ring pattern
• the ring volume settings

The GetRingerStatus request has these parameters:

GetRingerStatus Request Parameters
device	Mandatory	Specifies the physical element of the device.
ringer	Not used
extensions	Not used

Negative Acknowledgements:

• operation:invalidDeviceID - Sent if there is no station associated with the DeviceID
• stateIncompatibility:invalidDeviceState - Sent if the station is not available to use - not registered yet
• operation:generic - Sent if a operational error has occurred
• operation:serviceNotSupported - Sent if the requested service is not supported
• unspecified - Sent if an implementation specific error occurred.

The status of the ringer is returned in the response. The GetRingerStatusResponse contains these parameters:

GetRingerStatusResponse Parameters
ringerStatusList	Always provided	Specifies information about the specified ringer. The item in the list is of type RingerStatusItem. Currently, there is only one item in the list. The data provided in the item is shown in the RingerStatusItem Parameters table below.
extensions	Not Used

Each RingerStatusItem contains these parameters:

RingerStatusItem Parameters
ringer	Always provided	Indicates the ringerID.
ringMode	Always provided	Indicates if the ringer is in a ringing cycle.
ringCount	Not supported
ringPattern	Always provided	Indicates the value of the ringing pattern of the ringer.
ringVolAbs	Not supported

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GetRingerStatus()

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'.
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'.
static GetRingerStatus	unmarshalGetRingerStatus(java.io.Reader reader) Method unmarshalGetRingerStatus
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

GetRingerStatus

public GetRingerStatus()

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

getRinger

public java.lang.String getRinger()

Returns the value of field 'ringer'. The field 'ringer' has the following description: Specifies which ringer to query. If not provided, then information is obtained on all the ringers associated with the device.

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'.

setRinger

public void setRinger(java.lang.String ringer)

Sets the value of field 'ringer'. The field 'ringer' has the following description: Specifies which ringer to query. If not provided, then information is obtained on all the ringers associated with the device.

Parameters:

ringer - the value of field 'ringer'.

unmarshalGetRingerStatus

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

Method unmarshalGetRingerStatus

Parameters:

reader -

Returns:

GetRingerStatus

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