ch.ecma.csta.binding
Class DisplayListItem

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

All Implemented Interfaces:

java.io.Serializable

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

Specifies information about the specified display.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DisplayListItem()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CharacterSet	getCharacterSet() Returns the value of field 'characterSet'.
java.lang.String	getContentsOfDisplay() Returns the value of field 'contentsOfDisplay'.
java.lang.String	getDisplayID() Returns the value of field 'displayID'.
java.lang.Long	getLogicalColumns() Returns the value of field 'logicalColumns'.
java.lang.Long	getLogicalRows() Returns the value of field 'logicalRows'.
java.lang.Long	getPhysicalBaseColumnNumber() Returns the value of field 'physicalBaseColumnNumber'.
java.lang.Long	getPhysicalBaseRowNumber() Returns the value of field 'physicalBaseRowNumber'.
java.lang.Long	getPhysicalColumns() Returns the value of field 'physicalColumns'.
java.lang.Long	getPhysicalRows() Returns the value of field 'physicalRows'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setCharacterSet(CharacterSet characterSet) Sets the value of field 'characterSet'.
void	setContentsOfDisplay(java.lang.String contentsOfDisplay) Sets the value of field 'contentsOfDisplay'.
void	setDisplayID(java.lang.String displayID) Sets the value of field 'displayID'.
void	setLogicalColumns(java.lang.Long logicalColumns) Sets the value of field 'logicalColumns'.
void	setLogicalRows(java.lang.Long logicalRows) Sets the value of field 'logicalRows'.
void	setPhysicalBaseColumnNumber(java.lang.Long physicalBaseColumnNumber) Sets the value of field 'physicalBaseColumnNumber'.
void	setPhysicalBaseRowNumber(java.lang.Long physicalBaseRowNumber) Sets the value of field 'physicalBaseRowNumber'.
void	setPhysicalColumns(java.lang.Long physicalColumns) Sets the value of field 'physicalColumns'.
void	setPhysicalRows(java.lang.Long physicalRows) Sets the value of field 'physicalRows'.
static DisplayListItem	unmarshalDisplayListItem(java.io.Reader reader) Method unmarshalDisplayListItem
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

DisplayListItem

public DisplayListItem()

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

getCharacterSet

public CharacterSet getCharacterSet()

Returns the value of field 'characterSet'. The field 'characterSet' has the following description: Specifies the character set which is being used to represent the text on the display.

The complete set of possible values is:

• ASCII (default)
• Unicode
• Proprietary

Optional. Not supported

Returns:

CharacterSet

getContentsOfDisplay

public java.lang.String getContentsOfDisplay()

Returns the value of field 'contentsOfDisplay'. The field 'contentsOfDisplay' has the following description: Specifies the text on display as a string of characters consisting of the text on each row of the display (including spaces) concatenated together. The contentsOfDisplay parameter always contains the maximum number of characters on the display as indicated by the number of logicalRows and logicalColumns. Mandatory.

Returns:

String

getDisplayID

public java.lang.String getDisplayID()

Returns the value of field 'displayID'. The field 'displayID' has the following description: Indicates the display to which the other provided information applies. Mandatory.

Returns:

String

getLogicalColumns

public java.lang.Long getLogicalColumns()

Returns the value of field 'logicalColumns'. The field 'logicalColumns' has the following description: The number of columns on the logical display. Not supported.

Returns:

Long

getLogicalRows

public java.lang.Long getLogicalRows()

Returns the value of field 'logicalRows'. The field 'logicalRows' has the following description: The number of rows on the logical display. Not supported.

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. To be specific, the logical column that appears at the first column of the physical display. When the number of physicalColumns is equal to the number of logicalColumns this parameter will be omitted, otherwise it will be present. Not supported

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, this is the logical row that appears at the first row of the physical display. When the number of physicalRows is equal to the number of logicalRows this parameter will be omitted, otherwise it will be present. Not supported

Returns:

Long

getPhysicalColumns

public java.lang.Long getPhysicalColumns()

Returns the value of field 'physicalColumns'. The field 'physicalColumns' has the following description: The number of columns on the physical display. When the number of physicalColumns is equal to the number of logicalColumns this parameter will be omitted, otherwise it will be present. Not supported

Returns:

Long

getPhysicalRows

public java.lang.Long getPhysicalRows()

Returns the value of field 'physicalRows'. The field 'physicalRows' has the following description: The number of rows on the physical display. When the number of physicalRows is equal to the number of logicalRows this parameter will be omitted, otherwise it will be present. Not supported

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

setCharacterSet

public void setCharacterSet(CharacterSet characterSet)

Sets the value of field 'characterSet'. The field 'characterSet' has the following description: Specifies the character set which is being used to represent the text on the display.

The complete set of possible values is:

• ASCII (default)
• Unicode
• Proprietary

Optional. Not supported

Parameters:

characterSet - the value of field 'characterSet'.

setContentsOfDisplay

public void setContentsOfDisplay(java.lang.String contentsOfDisplay)

Sets the value of field 'contentsOfDisplay'. The field 'contentsOfDisplay' has the following description: Specifies the text on display as a string of characters consisting of the text on each row of the display (including spaces) concatenated together. The contentsOfDisplay parameter always contains the maximum number of characters on the display as indicated by the number of logicalRows and logicalColumns. Mandatory.

Parameters:

contentsOfDisplay - the value of field 'contentsOfDisplay'.

setDisplayID

public void setDisplayID(java.lang.String displayID)

Sets the value of field 'displayID'. The field 'displayID' has the following description: Indicates the display to which the other provided information applies. Mandatory.

Parameters:

displayID - the value of field 'displayID'.

setLogicalColumns

public void setLogicalColumns(java.lang.Long logicalColumns)

Sets the value of field 'logicalColumns'. The field 'logicalColumns' has the following description: The number of columns on the logical display. Not supported.

Parameters:

logicalColumns - the value of field 'logicalColumns'.

setLogicalRows

public void setLogicalRows(java.lang.Long logicalRows)

Sets the value of field 'logicalRows'. The field 'logicalRows' has the following description: The number of rows on the logical display. Not supported.

Parameters:

logicalRows - the value of field 'logicalRows'.

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. To be specific, the logical column that appears at the first column of the physical display. When the number of physicalColumns is equal to the number of logicalColumns this parameter will be omitted, otherwise it will be present. Not supported

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, this is the logical row that appears at the first row of the physical display. When the number of physicalRows is equal to the number of logicalRows this parameter will be omitted, otherwise it will be present. Not supported

Parameters:

physicalBaseRowNumber - the value of field 'physicalBaseRowNumber'.

setPhysicalColumns

public void setPhysicalColumns(java.lang.Long physicalColumns)

Sets the value of field 'physicalColumns'. The field 'physicalColumns' has the following description: The number of columns on the physical display. When the number of physicalColumns is equal to the number of logicalColumns this parameter will be omitted, otherwise it will be present. Not supported

Parameters:

physicalColumns - the value of field 'physicalColumns'.

setPhysicalRows

public void setPhysicalRows(java.lang.Long physicalRows)

Sets the value of field 'physicalRows'. The field 'physicalRows' has the following description: The number of rows on the physical display. When the number of physicalRows is equal to the number of logicalRows this parameter will be omitted, otherwise it will be present. Not supported

Parameters:

physicalRows - the value of field 'physicalRows'.

unmarshalDisplayListItem

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

Method unmarshalDisplayListItem

Parameters:

reader -

Returns:

DisplayListItem

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