Package de.gmxhome.conrad.jpos.jpos_base.remoteorderdisplay

Interface RemoteOrderDisplayInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

RemoteOrderDisplayProperties

public interface RemoteOrderDisplayInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the RemoteOrderDisplay device category. For details about properties, methods and method parameters, see UPOS specification, chapter Remote Order Display. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	autoToneDuration(int duration)	Final part of setting AutoToneDuration.
void	autoToneFrequency(int frequency)	Final part of setting AutoToneFrequency.
ClearVideo	clearVideo(int units, int attribute)	Validation part of ClearVideo method.
void	clearVideo(ClearVideo request)	Final part of ClearVideo method.
ClearVideoRegion	clearVideoRegion(int units, int row, int column, int height, int width, int attribute)	Validation part of ClearVideoRegion method.
void	clearVideoRegion(ClearVideoRegion request)	Final part of ClearVideoRegion method.
void	controlClock(int units, int function, int clockid, int hour, int minute, int second, int row, int column, int attribute, int mode)	Final part of ControlClock method.
void	controlCursor(int units, int function)	Final part of ControlCursor method.
CopyVideoRegion	copyVideoRegion(int units, int row, int column, int height, int width, int targetRow, int targetColumn)	Validation part of CopyVideoRegion method.
void	copyVideoRegion(CopyVideoRegion request)	Final part of CopyVideoRegion method.
void	currentUnitID(int unit)	Final part of setting CurrentUnitID.
DisplayData	displayData(int units, int row, int column, int attribute, String data)	Validation part of DisplayData method.
void	displayData(DisplayData request)	Final part of DisplayData method.
DrawBox	drawBox(int units, int row, int column, int height, int width, int attribute, int bordertype)	Validation part of DrawBox method.
void	drawBox(DrawBox request)	Final part of DrawBox method.
void	eventType(int type)	Final part of setting EventType.
void	freeVideoRegion(int units, int bufferId)	Final part of FreeVideoRegion method.
void	mapCharacterSet(boolean map)	Final part of setting MapCharacterSet.
void	resetVideo(int units)	Final part of ResetVideo method.
RestoreVideoRegion	restoreVideoRegion(int units, int targetRow, int targetColumn, int bufferId)	Validation part of RestoreVideoRegion method.
void	restoreVideoRegion(RestoreVideoRegion request)	Final part of RestoreVideoRegion method.
SaveVideoRegion	saveVideoRegion(int units, int row, int column, int height, int width, int bufferId)	Validation part of SaveVideoRegion method.
void	saveVideoRegion(SaveVideoRegion request)	Final part of SaveVideoRegion method.
void	selectChararacterSet(int units, int characterSet)	Final part of SelectChararacterSet method.
void	setCursor(int units, int row, int column)	Final part of SetCursor method.
void	timeout(int milliseconds)	Final part of setting Timeout.
TransactionDisplay	transactionDisplay(int units, int function)	Validation part of TransactionDisplay method.
void	transactionDisplay(TransactionDisplay request)	Final part of TransactionDisplay method.
UpdateVideoRegionAttribute	updateVideoRegionAttribute(int units, int function, int row, int column, int height, int width, int attribute)	Validation part of UpdateVideoRegionAttribute method.
void	updateVideoRegionAttribute(UpdateVideoRegionAttribute request)	Final part of UpdateVideoRegionAttribute method.
void	videoMode(int mode)	Final part of setting video mode.
VideoSound	videoSound(int units, int frequency, int duration, int numberOfCycles, int interSoundWait)	Validation part of VideoSound method.
void	videoSound(VideoSound request)	Final part of VideoSound method.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

autoToneDuration

void autoToneDuration(int duration)
               throws jpos.JposException

Final part of setting AutoToneDuration. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• The display specified by CurrentUnitID is online,
• The new property value is positive.

Parameters:

duration - New AutoToneDuration value

Throws:

jpos.JposException - If an error occurs

autoToneFrequency

void autoToneFrequency(int frequency)
                throws jpos.JposException

Final part of setting AutoToneFrequency. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• The display specified by CurrentUnitID is online,
• The new property value is positive.

Parameters:

frequency - New AutoToneFrequency value

Throws:

jpos.JposException - If an error occurs

currentUnitID

void currentUnitID(int unit)
            throws jpos.JposException

Final part of setting CurrentUnitID. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• The new property value is one of UID_x, where 1 ≤ x ≤ 32.

Parameters:

unit - New CurrentUnitID value

Throws:

jpos.JposException - If an error occurs

eventType

void eventType(int type)
        throws jpos.JposException

Final part of setting EventType. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has been opened,
• The new property value is a bitwise combination of DE_TOUCH_UP, DE_TOUCH_DOWN and DE_TOUCH_MOVE,
• internal property AllowAlwaysSetProperties is true or type equals the previous value of EventType.

-
-

Parameters:

type - New EventType value

Throws:

jpos.JposException - If an error occurs

mapCharacterSet

void mapCharacterSet(boolean map)
              throws jpos.JposException

Final part of setting MapCharacterSet. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has been opened,
• The new property value is false of CapMapCharacterSet is true.

Parameters:

map - New MapCharacterSet value

Throws:

jpos.JposException - If an error occurs

timeout

void timeout(int milliseconds)
      throws jpos.JposException

Final part of setting Timeout. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device has been opened,
• The new property value is positive,
• internal property AllowAlwaysSetProperties is true or milliseconds equals the previous value of Timeout.

Parameters:

milliseconds - New Timeout value

Throws:

jpos.JposException - If an error occurs

videoMode

void videoMode(int mode)
        throws jpos.JposException

Final part of setting video mode. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• The device unit specified by CurrentUnitID is online,
• The new property value one of the modes specified by VideoModesList.

Parameters:

mode - New video mode value

Throws:

jpos.JposException - If an error occurs

controlClock

void controlClock(int units,
 int function,
 int clockid,
 int hour,
 int minute,
 int second,
 int row,
 int column,
 int attribute,
 int mode)
           throws jpos.JposException

Final part of ControlClock method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• Device is idle
• All displays specified by units are online,
• function is CLK_PAUSE, CLK_START, CLK_RESUME, CLK_STOP or CLK_MOVE,
• clockid is > 0 and %le; the minimum Clocks value for all selected display units,
• if function = CLK_START, hour, minute and second are within the usual ranges (0-23, 0-59),
• if function = CLK_START, mode is one of CLK_SHORT, CLK_NORMAL, CLK_12_LONG or CLK_24_LONG,
• if function = CLK_START, attribute is between 0 and 255,
• if funktion is CLK_START or CLK_MOVE, row and column are valid start coordinates for all specified units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

function - The requested clock command.

clockid - The requested clock command.

hour - The initial hours for the clock display.

minute - The initial minutes for the clock display.

second - The initial seconds for the clock display.

row - The clock's row.

column - The clock's start column.

attribute - VGA-like attribute parameter, see UPOS specification, chapter Remote Order Display - General Information - Model.

mode - The type of clock to display.

Throws:

jpos.JposException - For details, see UPOS method ControlClock.

controlCursor

void controlCursor(int units,
 int function)
            throws jpos.JposException

Final part of ControlCursor method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• Device is idle
• All displays specified by units are online,
• function is CRS_LINE, CRS_LINE_BLINK, RS_BLOCK, CRS_BLOCK_BLINK or CRS_OFF.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

function - The cursor command, indicating the type of cursor to display.

Throws:

jpos.JposException - For details, see UPOS method ControlCursor.

freeVideoRegion

void freeVideoRegion(int units,
 int bufferId)
              throws jpos.JposException

Final part of FreeVideoRegion method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• All displays specified by units are online,
• All displays specified by units fulfill the following condition: 1 ≤ bufferId ≤ VideoSaveBuffers.

Keep in mind: VideoSaveBuffers can differ for different units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

bufferId - Number identifying the video buffer to free.

Throws:

jpos.JposException - For details, see UPOS method FreeVideoRegion.

resetVideo

void resetVideo(int units)
         throws jpos.JposException

Final part of ResetVideo method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• Device is idle
• All displays specified by units are online.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

Throws:

jpos.JposException - For details, see UPOS method ResetVideo.

selectChararacterSet

void selectChararacterSet(int units,
 int characterSet)
                   throws jpos.JposException

Final part of SelectChararacterSet method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• Device is idle
• All displays specified by units are online,
• For all displays specified by units property CapSelectCharacterSet is true,
• For all displays specified by units, property CharacterSetList contains characterSet .

Keep in mind: CapSelectCharacterSet and CharacterSetList can differ for different units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

characterSet - Contain the character set for displaying characters.

Throws:

jpos.JposException - For details, see UPOS method SelectChararacterSet.

setCursor

void setCursor(int units,
 int row,
 int column)
        throws jpos.JposException

Final part of SetCursor method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• Device is idle,
• All displays specified by units are online,
• For all displays specified by units, row and column are valid cursor coordinates.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

row - Row to place the cursor on.

column - Column to place the cursor on.

Throws:

jpos.JposException - For details, see UPOS method SetCursor.

clearVideo

ClearVideo clearVideo(int units,
 int attribute)
               throws jpos.JposException

Validation part of ClearVideo method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• 0 ≤ attribute ≤ 0xff,
• If AsyncMode is false: All display units specified by units are online.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

attribute - VGA-like attribute parameter, see UPOS specification, chapter Remote Order Display - General Information - Model.

Returns:

ClearVideo object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method ClearVideo.

clearVideo

void clearVideo(ClearVideo request)
         throws jpos.JposException

Final part of ClearVideo method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a ClearVideo object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by ClearVideo.

Throws:

jpos.JposException - For details, see UPOS method ClearVideo.

clearVideoRegion

ClearVideoRegion clearVideoRegion(int units,
 int row,
 int column,
 int height,
 int width,
 int attribute)
                           throws jpos.JposException

Validation part of ClearVideoRegion method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• row and column are positive values, height ≥ 1 and width ≥ 1.
• 0 ≤ attribute ≤ 0xff.

If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• row, column, height and width specify a valid region on all affected units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

row - Upper row of the specified region.

column - Left column of the specified region.

height - Height of the specified region.

width - Width of the specified region.

attribute - VGA-like attribute parameter, see UPOS specification, chapter Remote Order Display - General Information - Model.

Returns:

ClearVideoRegion object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method ClearVideoRegion.

clearVideoRegion

void clearVideoRegion(ClearVideoRegion request)
               throws jpos.JposException

Final part of ClearVideoRegion method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a ClearVideoRegion object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.
• request.getRow(), request.getColumn(), request.getHeight() and request.getWidth() specify a valid region on all affected units.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by ClearVideoRegion.

Throws:

jpos.JposException - For details, see UPOS method ClearVideoRegion.

copyVideoRegion

CopyVideoRegion copyVideoRegion(int units,
 int row,
 int column,
 int height,
 int width,
 int targetRow,
 int targetColumn)
                         throws jpos.JposException

Validation part of CopyVideoRegion method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• row, column, targetRow and targetColumn are positive values, height ≥ 1 and width ≥ 1.

If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• row, column, height and width specify a valid region on all affected units,
• targetRow, targetColumn, height and width specify a valid region on all affected units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

row - Upper row of the specified region.

column - Left column of the specified region.

height - Height of the specified region.

width - Width of the specified region.

targetRow - Upper row of target location.

targetColumn - Left column of target location.

Returns:

CopyVideoRegion object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method CopyVideoRegion.

copyVideoRegion

void copyVideoRegion(CopyVideoRegion request)
              throws jpos.JposException

Final part of CopyVideoRegion method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a CopyVideoRegion object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.
• request.getRow(), request.getColumn(), request.getHeight() and request.getWidth() specify a valid region on all affected units.
• request.getTargetRow(), request.getTargetColumn(), request.getHeight() and request.getWidth() specify a valid region on all affected units.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by CopyVideoRegion.

Throws:

jpos.JposException - For details, see UPOS method CopyVideoRegion.

displayData

DisplayData displayData(int units,
 int row,
 int column,
 int attribute,
 String data)
                 throws jpos.JposException

Validation part of DisplayData method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• row and column are positive values,
• 0 ≤ attribute ≤ 0xff.

If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• row and column specify a valid coordinate on all affected units.

Parameters:

units - Units where status has been changed.

row - (Upper) Row where operation shall start.

column - (Left) Column where operation shall start.

attribute - VGA-like attribute parameter, see UPOS specification, chapter Remote Order Display - General Information - Model.

data - Text to be displayed.

Returns:

DisplayData object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method DisplayData.

displayData

void displayData(DisplayData request)
          throws jpos.JposException

Final part of DisplayData method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a DisplayData object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by units are online,
• request.getRow() and request.getColumn() specify a valid coordinate on all affected units.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by DisplayData.

Throws:

jpos.JposException - For details, see UPOS method DisplayData.

drawBox

DrawBox drawBox(int units,
 int row,
 int column,
 int height,
 int width,
 int attribute,
 int bordertype)
         throws jpos.JposException

Validation part of DrawBox method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• row and column are positive values, height ≥ 1 and width ≥ 1,
• 0 ≤ attribute ≤ 0xff,
• bordertype is one of BDR_SINGLE, BDR_DOUBLE or BDR_SOLID.

If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• row, column, height and width specify a valid region on all affected units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

row - Upper row of the specified region.

column - Left column of the specified region.

height - Height of the specified region.

width - Width of the specified region.

attribute - VGA-like attribute parameter, see UPOS specification, chapter Remote Order Display - General Information - Model.

bordertype - The border type to be drawn.

Returns:

DrawBox object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method ClearVideoRegion.

drawBox

void drawBox(DrawBox request)
      throws jpos.JposException

Final part of DrawBox method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a DrawBox object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.
• request.getRow(), request.getColumn(), request.getHeight() and request.getWidth() specify a valid region on all affected units.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by DrawBox.

Throws:

jpos.JposException - For details, see UPOS method DrawBox.

restoreVideoRegion

RestoreVideoRegion restoreVideoRegion(int units,
 int targetRow,
 int targetColumn,
 int bufferId)
                               throws jpos.JposException

Validation part of RestoreVideoRegion method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• targetRow and targetColumn are positive values,
• 1 ≤ bufferId.

If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• row and column specify a valid coordinate on all affected units,
• bufferId ≤ VideoSaveBuffers.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

targetRow - Upper row of target location.

targetColumn - Left column of target location.

bufferId - Number identifying the source video buffer to use.

Returns:

RestoreVideoRegion object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method RestoreVideoRegion.

restoreVideoRegion

void restoreVideoRegion(RestoreVideoRegion request)
                 throws jpos.JposException

Final part of RestoreVideoRegion method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a RestoreVideoRegion object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.
• request.getTargetRow() and request.getTargetColumn() specify a valid coordinate on all affected units.
• request.getBufferId() ≤ VideoSaveBuffers.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by RestoreVideoRegion.

Throws:

jpos.JposException - For details, see UPOS method RestoreVideoRegion.

saveVideoRegion

SaveVideoRegion saveVideoRegion(int units,
 int row,
 int column,
 int height,
 int width,
 int bufferId)
                         throws jpos.JposException

Validation part of SaveVideoRegion method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• row and column are positive values, height ≥ 1 and width ≥ 1.
• 1 ≤ bufferId.

If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• row, column, height and width specify a valid region on all affected units,
• bufferId ≤ VideoSaveBuffers for all specified units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

row - Upper row of the specified region.

column - Left column of the specified region.

height - Height of the specified region.

width - Width of the specified region.

bufferId - Number identifying the video buffer to use.

Returns:

SaveVideoRegion object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method SaveVideoRegion.

saveVideoRegion

void saveVideoRegion(SaveVideoRegion request)
              throws jpos.JposException

Final part of SaveVideoRegion method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a SaveVideoRegion object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.
• request.getRow(), request.getColumn(), request.getHeight() and request.getWidth() specify a valid region on all affected units.
• request.getBufferId() ≤ VideoSaveBuffers.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by SaveVideoRegion.

Throws:

jpos.JposException - For details, see UPOS method SaveVideoRegion.

transactionDisplay

TransactionDisplay transactionDisplay(int units,
 int function)
                               throws jpos.JposException

Validation part of TransactionDisplay method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• function is one of TD_TRANSACTION or TD_NORMAL.

If function is TD_TRANSACTION, the following condition has been checked as well:

• No transaction is active.

If function is TD_NORMAL, the following condition has been checked, too:

• A transaction is in progress.
• If AsyncMode is false, the following condition has been checked as well:
  - All display units specified by units are online.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

function - Transaction control function.

Returns:

TransactionDisplay object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method TransactionDisplay.

transactionDisplay

void transactionDisplay(TransactionDisplay request)
                 throws jpos.JposException

Final part of TransactionDisplay method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a TransactionDisplay object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by TransactionDisplay.

Throws:

jpos.JposException - For details, see UPOS method TransactionDisplay.

updateVideoRegionAttribute

UpdateVideoRegionAttribute updateVideoRegionAttribute(int units,
 int function,
 int row,
 int column,
 int height,
 int width,
 int attribute)
                                               throws jpos.JposException

Validation part of UpdateVideoRegionAttribute method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• function is one of UA_SET, UA_INTENSITY_ON, UA_INTENSITY_OFF, UA_REVERSE_ON, UA_REVERSE_OFF, UA_BLINK_ON, or UA_BLINK_OFF,
• row and column are positive values, height ≥ 1 and width ≥ 1.

If function = UA_SET: 0 ≤ attribute ≤ 0xff.
If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• row, column, height and width specify a valid region on all affected units.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

function - The attribute command.

row - Upper row of the specified region.

column - Left column of the specified region.

height - Height of the specified region.

width - Width of the specified region.

attribute - VGA-like attribute parameter, see UPOS specification, chapter Remote Order Display - General Information - Model.

Returns:

UpdateVideoRegionAttribute object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method UpdateVideoRegionAttribute.

updateVideoRegionAttribute

void updateVideoRegionAttribute(UpdateVideoRegionAttribute request)
                         throws jpos.JposException

Final part of UpdateVideoRegionAttribute method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a UpdateVideoRegionAttribute object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.
• request.getRow(), request.getColumn(), request.getHeight() and request.getWidth() specify a valid region on all affected units.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by UpdateVideoRegionAttribute.

Throws:

jpos.JposException - For details, see UPOS method UpdateVideoRegionAttribute.

videoSound

VideoSound videoSound(int units,
 int frequency,
 int duration,
 int numberOfCycles,
 int interSoundWait)
               throws jpos.JposException

Validation part of VideoSound method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,

If AsyncMode is false, the following conditions have been checked, too:

• All display units specified by units are online,
• For all affected units, CapTone is true.

Parameters:

units - Bitwise mask indicating which video unit(s) to operate on.

frequency - Tone frequency in Hertz.

duration - Tone duration in milliseconds.

numberOfCycles - Number of cycles to generate tone.

interSoundWait - Delay between sounds, in milliseconds.

Returns:

VideoSound object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method VideoSound.

videoSound

void videoSound(VideoSound request)
         throws jpos.JposException

Final part of VideoSound method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a UpdateVideoRegionAttribute object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
In case of asynchronous processing, the following additional checks have been made before invocation:

• All display units specified by request.getUnits() are online.
• For all affected units, CapTone is true.

Parameters:

request - Output request object returned by validation method that contains all parameters to be used by VideoSound.

Throws:

jpos.JposException - For details, see UPOS method VideoSound.