ch.ecma.csta.binding
Class RingerStatusItem

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

All Implemented Interfaces:

java.io.Serializable

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

Specifies information about the specified ringer, including state, cycles, pattern, and volume.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

RingerStatusItem()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.Integer	getRingCount() Returns the value of field 'ringCount'.
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'.
java.lang.Integer	getRingVolAbs() Returns the value of field 'ringVolAbs'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setRingCount(java.lang.Integer ringCount) Sets the value of field 'ringCount'.
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	setRingVolAbs(java.lang.Integer ringVolAbs) Sets the value of field 'ringVolAbs'.
static RingerStatusItem	unmarshalRingerStatusItem(java.io.Reader reader) Method unmarshalRingerStatusItem
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

RingerStatusItem

public RingerStatusItem()

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

getRingCount

public java.lang.Integer getRingCount()

Returns the value of field 'ringCount'. The field 'ringCount' has the following description: Not supported. Indicates the value (0...1000) of the number of complete ring cycles that the ringer has been, or was, ringing. The values 0-999 indicate the actual number of complete ring cycles. The value of 1000 indicates that a value greater than 999 was reached. Optional.

Returns:

Integer

getRingMode

public RingMode getRingMode()

Returns the value of field 'ringMode'. The field 'ringMode' has the following description: Indicates if the ringer is in a ringing cycle.

The complete set of possible values is:

• ringing - The ringer is ringing (provided when either the ringer is physically ringing or is in the quiet phase of a ring cycle).
• not ringing - The ringer is not being rung.

Mandatory.

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 ringing patterns and the number of supported patterns is device specific. The ring pattern is associated with the ringer until reset by the switching function or until reset by the Set Ringer Status request. Optional.

Returns:

Long

getRingVolAbs

public java.lang.Integer getRingVolAbs()

Returns the value of field 'ringVolAbs'. The field 'ringVolAbs' has the following description: Not supported. Indicates the absolute volume level (0...100) of the ringer. The ring volume is associated with the ringer until reset by the switching function or until reset by the Set Ringer Status service. A value of 0 indicates silence, and 100 indicates maximum volume. The granularity and quantization of the values 1 though 99 are device specific. If this component is not provided, the absolute ringer volume is unknown. Note that the relationship between the ringer volume and loudness is ringer specific. Optional.

Returns:

Integer

getRinger

public java.lang.String getRinger()

Returns the value of field 'ringer'. The field 'ringer' has the following description: Indicates the ringerID. 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

setRingCount

public void setRingCount(java.lang.Integer ringCount)

Sets the value of field 'ringCount'. The field 'ringCount' has the following description: Not supported. Indicates the value (0...1000) of the number of complete ring cycles that the ringer has been, or was, ringing. The values 0-999 indicate the actual number of complete ring cycles. The value of 1000 indicates that a value greater than 999 was reached. Optional.

Parameters:

ringCount - the value of field 'ringCount'.

setRingMode

public void setRingMode(RingMode ringMode)

Sets the value of field 'ringMode'. The field 'ringMode' has the following description: Indicates if the ringer is in a ringing cycle.

The complete set of possible values is:

• ringing - The ringer is ringing (provided when either the ringer is physically ringing or is in the quiet phase of a ring cycle).
• not ringing - The ringer is not being rung.

Mandatory.

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 ringing patterns and the number of supported patterns is device specific. The ring pattern is associated with the ringer until reset by the switching function or until reset by the Set Ringer Status request. Optional.

Parameters:

ringPattern - the value of field 'ringPattern'.

setRingVolAbs

public void setRingVolAbs(java.lang.Integer ringVolAbs)

Sets the value of field 'ringVolAbs'. The field 'ringVolAbs' has the following description: Not supported. Indicates the absolute volume level (0...100) of the ringer. The ring volume is associated with the ringer until reset by the switching function or until reset by the Set Ringer Status service. A value of 0 indicates silence, and 100 indicates maximum volume. The granularity and quantization of the values 1 though 99 are device specific. If this component is not provided, the absolute ringer volume is unknown. Note that the relationship between the ringer volume and loudness is ringer specific. Optional.

Parameters:

ringVolAbs - the value of field 'ringVolAbs'.

setRinger

public void setRinger(java.lang.String ringer)

Sets the value of field 'ringer'. The field 'ringer' has the following description: Indicates the ringerID. Mandatory.

Parameters:

ringer - the value of field 'ringer'.

unmarshalRingerStatusItem

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

Method unmarshalRingerStatusItem

Parameters:

reader -

Returns:

RingerStatusItem

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