4.1.0.610 20071213

ch.ecma.csta.binding
Class GetDisplay

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

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

Gets a snapshot of the contents of the physical device's display. The capabilities exchange services can be used to determine the number of displays associated with a device. The GetDisplay request has these parameters:

GetDisplay Request Parameters
device Mandatory Specifies the physical element of the device.
displayID Not used
extensions Not used

Negative Acknowledgements:

The requested button information is returned in the GetDisplayResponse. Here are the parameters that are returned:

GetDisplayResponse Parameters
displayList Always provided Specifies information about the specified display associated with the device. The list item is of type DisplayListItem. The DisplayListItem structure is described below.
extensions Not Used

The DisplayListItem in the displayList contains these parameters:

DisplayListItem Parameters
displayID Always Provided This parameter indicates the display to which the other provided information applies.
logicalRowsNot supported
logicalColumnsNot supported
physicalRowsNot supported
physicalColumnsNot supported
physicalBaseRowNumberNot supported
physicalBaseColumnNumberNot supported
characterSetNot supported
contentsOfDisplay Always provided Specifies the text on display as a string of characters consisting of the text on each row of the display (including spaces) concatenated together.

There are no events generated from this service.

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

Constructor Summary
GetDisplay()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 DeviceID getDevice()
          Returns the value of field 'device'.
 java.lang.String getDisplay()
          Returns the value of field 'display'.
 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 setDisplay(java.lang.String display)
          Sets the value of field 'display'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
static GetDisplay unmarshalGetDisplay(java.io.Reader reader)
          Method unmarshalGetDisplay
 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

GetDisplay

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

getDisplay

public java.lang.String getDisplay()
Returns the value of field 'display'.

Returns:
String

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

setDisplay

public void setDisplay(java.lang.String display)
Sets the value of field 'display'.

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

setExtensions

public void setExtensions(CSTACommonArguments extensions)
Sets the value of field 'extensions'.

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

unmarshalGetDisplay

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

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