4.1.0.610 20071213

ch.ecma.csta.binding
Class ButtonPress

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

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

Simulates the activation of a specified button at a specified device. The button model is described in Button.

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

A Button Press could initiate any potential call sequences, but these sequences would appear as manually initiated activities equivalent to a user pressing the given button on the set. Invoking a speed-dial button is an example of a common use for the Button Press service.

The ButtonPress request has these parameters:

ButtonPress Request Parameters
device Mandatory Specifies the device's phsical element.
button Mandatory Specifies the address of the button to be pressed on the device. Use the Button Id constant enumerations.
extensions Not Used

The ButtonPressResponse does not provide any useful information. It just indicates that the request is valid and is being processed. Any error in the request will be indicated by an Exception. The events that may be generated from the request include:

Implementation of CSTA's Functional Requirements
  1. A ButtonPress could initiate any potential call sequences, but these sequences would appear as manually initiated activities equivalent to a user pressing the given button on the set. Invoking a speed-dial button is an example of a common use for the ButtonPress request.

Negative Acknowledgements:

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

Constructor Summary
ButtonPress()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 java.lang.String getButton()
          Returns the value of field 'button'.
 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 setButton(java.lang.String button)
          Sets the value of field 'button'.
 void setDevice(DeviceID device)
          Sets the value of field 'device'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
static ButtonPress unmarshalButtonPress(java.io.Reader reader)
          Method unmarshalButtonPress
 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

ButtonPress

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

getButton

public java.lang.String getButton()
Returns the value of field 'button'. The field 'button' has the following description: Specifies the button on the device. Use the Button Id constant enumerations. Mandatory.

Returns:
String

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

setButton

public void setButton(java.lang.String button)
Sets the value of field 'button'. The field 'button' has the following description: Specifies the button on the device. Use the Button Id constant enumerations. Mandatory.

Parameters:
button - the value of field 'button'.

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

unmarshalButtonPress

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

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