ch.ecma.csta.binding
Class RingerStatusEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that the ringer attribute associated with a device has changed.

This event may be generated in any one of the following ways:

• The ringer status has been changed via the SetRingerStatus request.
• The switching function has changed the ringer status.

Note that this event only indicates the status of a ringer. Call control events such as the DeliveredEvent should be used to determine call activity at a device.

At least one of the following parameters will be provided:

• ring mode
• ring count
• ring pattern
• ring volume.

The parameters of the the RingerStatusEvent structure are:

RingerStatusEvent Parameters
monitorCrossRefID	Not used	Ignore. Currently only used internally.
device	Always provided	Specifies the device whre the ring status was changed. Type is SubjectDeviceID.
ringer	Always provided	Indicates the ringerID. Always set to "0000" since there is only one ringer.
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.
ringVolume	Not supported
extensions	Not supported

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

RingerStatusEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
SubjectDeviceID	getDevice() Returns the value of field 'device'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
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'.
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(SubjectDeviceID device) Sets the value of field 'device'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
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	setRingVolume(Volume ringVolume) Sets the value of field 'ringVolume'.
static RingerStatusEvent	unmarshalRingerStatusEvent(java.io.Reader reader) Method unmarshalRingerStatusEvent
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

RingerStatusEvent

public RingerStatusEvent()

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 SubjectDeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device where the ring status was changed. Mandatory.

Returns:

SubjectDeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getRingCount

public java.lang.Integer getRingCount()

Returns the value of field 'ringCount'. The field 'ringCount' has the following description: Indicates the number of complete ring cycles that the ringer has been 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 an active ring cycle. Optional.

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 in an active ring cycle.

Returns:

RingMode

getRingPattern

public java.lang.Long getRingPattern()

Returns the value of field 'ringPattern'. The field 'ringPattern' has the following description: Indicates the ringing pattern of the ringer. The meaning of the ringing pattern and the number of ringing patterns is device specific. In order to decode this value for Avaya IP endpoints, use the com.avaya.csta.phsyical.RingerPatternConstants class. Optional.

Returns:

Long

getRingVolume

public Volume getRingVolume()

Returns the value of field 'ringVolume'. The field 'ringVolume' has the following description: Indicates the ring volume as an absolute value or that the volume was incremented or decremented by a switch specified increment. The ring volume is associated with the ringer until reset by the switching function or until reset by the Set Ringer Status service. 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 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.

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 ringerID associated with the device. Always set to "0000" since there is only one ringer. 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(SubjectDeviceID device)

Sets the value of field 'device'. The field 'device' has the following description: Specifies the device where the ring status was changed. 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'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setRingCount

public void setRingCount(java.lang.Integer ringCount)

Sets the value of field 'ringCount'. The field 'ringCount' has the following description: Indicates the number of complete ring cycles that the ringer has been 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 an active ring cycle. Optional.

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 in an active ring cycle.

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 ringing pattern of the ringer. The meaning of the ringing pattern and the number of ringing patterns is device specific. In order to decode this value for Avaya IP endpoints, use the com.avaya.csta.phsyical.RingerPatternConstants class. Optional.

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 ring volume as an absolute value or that the volume was incremented or decremented by a switch specified increment. The ring volume is associated with the ringer until reset by the switching function or until reset by the Set Ringer Status service. 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 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.

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 ringerID associated with the device. Always set to "0000" since there is only one ringer. Mandatory.

Parameters:

ringer - the value of field 'ringer'.

unmarshalRingerStatusEvent

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

Method unmarshalRingerStatusEvent

Parameters:

reader -

Returns:

RingerStatusEvent

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