ch.ecma.csta.binding
Class DisplayUpdatedEvent

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

All Implemented Interfaces:

java.io.Serializable

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

The DisplayUpdatedEvent occurs if the contents of a device's display have changed.

The parameters of the DisplayUpdatedEvent structure are:

DisplayUpdatedEvent Parameters
monitorCrossRefID	Not used	Ignore. Currently only used internally.
device	Always provided	Specifies the device where the display information was changed. Type is SubjectDeviceID.
displayID	Not supported
logicalRows	Always provided	Always set to 1.
logicalColumns	Always provided	Always set to 48.
physicalRows	Not supported
physicalColumns	Not supported
physicalBaseRowNumber	Not supported
physicalBaseColumnNumber	Not supported
characterSet	Not 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.
extensions	Not supported

Implementation of CSTA's Functional Requirements:

1. Since the contentsOfDisplay parameter is a String object, the number of characters in the String can be determined by String.length().
2. The characterSet parameter is not supported.
3. Anytime the display associated with a device is updated by Communication Manager, the Display Updated event is generated. In a Display Updated event, the entire contents of the specified display is provided. The application may compare the received display snapshots to track specific changes in the display.
4. This event is generated when a display update has been completed by the Communication Manager. Before Communication Manager begins updating a display, it erases all or part of the display first. This event is generated for these full or partial erasures, too, so you will see two events for every display update:
   1. One for the full or partial erasure
   2. Another for the new display data
   Local, station-controlled updates, such as the display of digits that are pressed at the station do not trigger Display Updated events.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DisplayUpdatedEvent()

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'.
SubjectDeviceID	getDevice() Returns the value of field 'device'.
java.lang.String	getDisplayID() Returns the value of field 'displayID'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.Long	getLogicalColumns() Returns the value of field 'logicalColumns'.
java.lang.Long	getLogicalRows() Returns the value of field 'logicalRows'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
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	setDevice(SubjectDeviceID device) Sets the value of field 'device'.
void	setDisplayID(java.lang.String displayID) Sets the value of field 'displayID'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
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	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
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 DisplayUpdatedEvent	unmarshalDisplayUpdatedEvent(java.io.Reader reader) Method unmarshalDisplayUpdatedEvent
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

DisplayUpdatedEvent

public DisplayUpdatedEvent()

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: 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. Always provided.

Returns:

String

getDevice

public SubjectDeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device where the display information was changed. Type is SubjectDeviceID. Always provided.

Returns:

SubjectDeviceID

getDisplayID

public java.lang.String getDisplayID()

Returns the value of field 'displayID'. The field 'displayID' has the following description: Not supported.

Returns:

String

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getLogicalColumns

public java.lang.Long getLogicalColumns()

Returns the value of field 'logicalColumns'. The field 'logicalColumns' has the following description: Always set to 48. Alway provided.

Returns:

Long

getLogicalRows

public java.lang.Long getLogicalRows()

Returns the value of field 'logicalRows'. The field 'logicalRows' has the following description: Always set to 1. Alway provided.

Returns:

Long

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getPhysicalBaseColumnNumber

public java.lang.Long getPhysicalBaseColumnNumber()

Returns the value of field 'physicalBaseColumnNumber'. The field 'physicalBaseColumnNumber' has the following description: Not supported.

Returns:

Long

getPhysicalBaseRowNumber

public java.lang.Long getPhysicalBaseRowNumber()

Returns the value of field 'physicalBaseRowNumber'. The field 'physicalBaseRowNumber' has the following description: Not supported.

Returns:

Long

getPhysicalColumns

public java.lang.Long getPhysicalColumns()

Returns the value of field 'physicalColumns'. The field 'physicalColumns' has the following description: Not supported.

Returns:

Long

getPhysicalRows

public java.lang.Long getPhysicalRows()

Returns the value of field 'physicalRows'. The field 'physicalRows' has the following description: 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: 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. Always provided.

Parameters:

contentsOfDisplay - the value of field 'contentsOfDisplay'.

setDevice

public void setDevice(SubjectDeviceID device)

Sets the value of field 'device'. The field 'device' has the following description: Specifies the device where the display information was changed. Type is SubjectDeviceID. Always provided.

Parameters:

device - the value of field 'device'.

setDisplayID

public void setDisplayID(java.lang.String displayID)

Sets the value of field 'displayID'. The field 'displayID' has the following description: Not supported.

Parameters:

displayID - the value of field 'displayID'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setLogicalColumns

public void setLogicalColumns(java.lang.Long logicalColumns)

Sets the value of field 'logicalColumns'. The field 'logicalColumns' has the following description: Always set to 48. Alway provided.

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: Always set to 1. Alway provided.

Parameters:

logicalRows - the value of field 'logicalRows'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setPhysicalBaseColumnNumber

public void setPhysicalBaseColumnNumber(java.lang.Long physicalBaseColumnNumber)

Sets the value of field 'physicalBaseColumnNumber'. The field 'physicalBaseColumnNumber' has the following description: 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: 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: 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: Not supported.

Parameters:

physicalRows - the value of field 'physicalRows'.

unmarshalDisplayUpdatedEvent

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

Method unmarshalDisplayUpdatedEvent

Parameters:

reader -

Returns:

DisplayUpdatedEvent

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