ch.ecma.csta.binding
Class SetDisplay

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

This Sets the display on a specified device. The GetDisplay service can be used to determine the size of a specific display. The display area available to the Set Display service may be larger than the visible display area. For example, the display may use paging or scrolling to bring portions of the display into view. All display services and events reference the entire display size rather than only the simultaneously-visible size. Similarly, any formatting or display manipulation to sequentially present multiple pages of information are the responsibility of the switching function and display.

The capabilities exchange services can be used to determine the number of displays associated with a device.

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

This service will only affect the areas of the display which are overlaid with the characters in the contentsOfDisplay parameter. The Set Display service overwrites existing display contents on a character-position by character-position basis. (Character positions which are before or after the character positions of the to-be-displayed characters are not affected.)

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SetDisplay()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getContentsOfDisplay() Returns the value of field 'contentsOfDisplay'.
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'.
java.lang.Long	getOffset() Returns the value of field 'offset'.
java.lang.Long	getPhysicalBaseColumnNumber() Returns the value of field 'physicalBaseColumnNumber'.
java.lang.Long	getPhysicalBaseRowNumber() Returns the value of field 'physicalBaseRowNumber'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setContentsOfDisplay(java.lang.String contentsOfDisplay) Sets the value of field 'contentsOfDisplay'.
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'.
void	setOffset(java.lang.Long offset) Sets the value of field 'offset'.
void	setPhysicalBaseColumnNumber(java.lang.Long physicalBaseColumnNumber) Sets the value of field 'physicalBaseColumnNumber'.
void	setPhysicalBaseRowNumber(java.lang.Long physicalBaseRowNumber) Sets the value of field 'physicalBaseRowNumber'.
static SetDisplay	unmarshalSetDisplay(java.io.Reader reader) Method unmarshalSetDisplay
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

SetDisplay

public SetDisplay()

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

getContentsOfDisplay

public java.lang.String getContentsOfDisplay()

Returns the value of field 'contentsOfDisplay'. The field 'contentsOfDisplay' has the following description: Specifies the text to place on the display as a string of characters consisting of the text on each row of the display (including spaces) concatenated together. If a null string is sent, the display will be cleared. 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

getDisplay

public java.lang.String getDisplay()

Returns the value of field 'display'. The field 'display' has the following description: Specifies which display on the physical device needs to be set. If the device has only one display this parameter may be omitted, but it may also be filled in (specifying the one and only displayID). If the device has more than one display this parameter will be present.

Returns:

String

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getOffset

public java.lang.Long getOffset()

Returns the value of field 'offset'. The field 'offset' has the following description: Specifies the offset, in number-of-characters (not bytes in the characters-to-be-displayed message string), where text is to start on the display.

Allowed values are from zero (default) to (MaxNbrOfLogicalColumns * MaxNbrOfLogicalRows - 1). Non-printable characters (for example, Carriage Return (CR), Line Feed (LF), and Tab) are counted in determining offsets and the message length. Optional.

Returns:

Long

getPhysicalBaseColumnNumber

public java.lang.Long getPhysicalBaseColumnNumber()

Returns the value of field 'physicalBaseColumnNumber'. The field 'physicalBaseColumnNumber' has the following description: The column number of the physical base, that is, the logical column that appears at the first column of the physical display. This parameter may be omitted or may be present when it needs to be changed. This parameter will be omitted when it is not relevant because the number of physical columns is equal to the number of logical columns. Optional.

Returns:

Long

getPhysicalBaseRowNumber

public java.lang.Long getPhysicalBaseRowNumber()

Returns the value of field 'physicalBaseRowNumber'. The field 'physicalBaseRowNumber' has the following description: The row number of the physical base, that is, the logical row that appears at the first row of the physical display. This parameter may be omitted or may be present when it needs to be changed. The parameter will be omitted when it is not relevant because the number of physical rows is equal to the number of logical rows. Optional.

Returns:

Long

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

setContentsOfDisplay

public void setContentsOfDisplay(java.lang.String contentsOfDisplay)

Sets the value of field 'contentsOfDisplay'. The field 'contentsOfDisplay' has the following description: Specifies the text to place on the display as a string of characters consisting of the text on each row of the display (including spaces) concatenated together. If a null string is sent, the display will be cleared. Mandatory.

Parameters:

contentsOfDisplay - the value of field 'contentsOfDisplay'.

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'. The field 'display' has the following description: Specifies which display on the physical device needs to be set. If the device has only one display this parameter may be omitted, but it may also be filled in (specifying the one and only displayID). If the device has more than one display this parameter will be present.

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

setOffset

public void setOffset(java.lang.Long offset)

Sets the value of field 'offset'. The field 'offset' has the following description: Specifies the offset, in number-of-characters (not bytes in the characters-to-be-displayed message string), where text is to start on the display.

Allowed values are from zero (default) to (MaxNbrOfLogicalColumns * MaxNbrOfLogicalRows - 1). Non-printable characters (for example, Carriage Return (CR), Line Feed (LF), and Tab) are counted in determining offsets and the message length. Optional.

Parameters:

offset - the value of field 'offset'.

setPhysicalBaseColumnNumber

public void setPhysicalBaseColumnNumber(java.lang.Long physicalBaseColumnNumber)

Sets the value of field 'physicalBaseColumnNumber'. The field 'physicalBaseColumnNumber' has the following description: The column number of the physical base, that is, the logical column that appears at the first column of the physical display. This parameter may be omitted or may be present when it needs to be changed. This parameter will be omitted when it is not relevant because the number of physical columns is equal to the number of logical columns. Optional.

Parameters:

physicalBaseColumnNumber - the value of field 'physicalBaseColumnNumber'.

setPhysicalBaseRowNumber

public void setPhysicalBaseRowNumber(java.lang.Long physicalBaseRowNumber)

Sets the value of field 'physicalBaseRowNumber'. The field 'physicalBaseRowNumber' has the following description: The row number of the physical base, that is, the logical row that appears at the first row of the physical display. This parameter may be omitted or may be present when it needs to be changed. The parameter will be omitted when it is not relevant because the number of physical rows is equal to the number of logical rows. Optional.

Parameters:

physicalBaseRowNumber - the value of field 'physicalBaseRowNumber'.

unmarshalSetDisplay

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

Method unmarshalSetDisplay

Parameters:

reader -

Returns:

SetDisplay

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