4.1.0.610 20071213

ch.ecma.csta.binding
Class GetMessageWaitingIndicator

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

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

Gets the message waiting status at a specified device. The message waiting feature is typically used to notify a user (typically via a dedicated lamp on a phone device) when messages are available.

The GetMessageWaitingIndicator request has these parameters:

GetMessageWaitingIndicator Request Parameters
device Mandatory Specifies the physical element of the device.
extensions Not Used

Negative Acknowledgements:

The status of the message waiting indicator is returned in the response. The GetMessageWaitingIndicatorResponse contains these parameters:

GetMessageWaitingIndicatorResponse Parameters
messageWaitingOn Always provided Specifies the value of the requested feature. The complete set of possible values is:
  • false - Message waiting off.
  • true - Message waiting on.
deviceForMessage Not Supported
lampIsPresent Not Supported
extensions Not Used

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

Constructor Summary
GetMessageWaitingIndicator()
           
 
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'.
 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'.
static GetMessageWaitingIndicator unmarshalGetMessageWaitingIndicator(java.io.Reader reader)
          Method unmarshalGetMessageWaitingIndicator
 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

GetMessageWaitingIndicator

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

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

unmarshalGetMessageWaitingIndicator

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

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