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

Class RemoteOrderDisplayProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.remoteorderdisplay.RemoteOrderDisplayProperties
All Implemented Interfaces:
JposBaseInterface, RemoteOrderDisplayInterface
public class RemoteOrderDisplayProperties extends JposCommonProperties implements RemoteOrderDisplayInterface
Class containing the remote order display specific properties, their default values and default implementations of RemoteOrderDisplayInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Remote Order Display.

  • Field Details

    • AutoToneDuration

      public int AutoToneDuration
      UPOS property AutoToneDuration.

    • AutoToneFrequency

      public int AutoToneFrequency
      UPOS property AutoToneFrequency.

    • CapSelectCharacterSet

      public boolean CapSelectCharacterSet
      UPOS property CapSelectCharacterSet.

    • CapTone

      public boolean CapTone
      UPOS property CapTone.

    • CapTouch

      public boolean CapTouch
      UPOS property CapTouch.

    • CharacterSet

      public int CharacterSet
      UPOS property CharacterSet.

    • CharacterSetList

      public String CharacterSetList
      UPOS property CharacterSetList.

    • Clocks

      public int Clocks
      UPOS property Clocks.

    • VideoMode

      public int VideoMode
      UPOS property VideoMode.

    • VideoModesList

      public String VideoModesList
      UPOS property VideoModesList.

    • VideoSaveBuffers

      public int VideoSaveBuffers
      UPOS property VideoSaveBuffers.

    • Unit

      public final RemoteOrderDisplayProperties.UnitProperties[] Unit
      Unit specific properties, one per possible unit.

    • CharacterSetDef

      public int CharacterSetDef
      Default value of CharacterSet property for offline units. Default: ROD_CS_ASCII. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • VideoModeDef

      public int VideoModeDef
      Default value of VideoMode property for offline units. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • VideoModesListDef

      public String VideoModesListDef
      Default value of VideoModesList property for offline units. Default: "0:0x0x0M". Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapMapCharacterSetDef

      public boolean CapMapCharacterSetDef
      Default value of CapMapCharacterSet property. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • EventTypeDef

      public int EventTypeDef
      Default value of EventType property. Default: 0 (no data events). Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • MapCharacterSetDef

      public boolean MapCharacterSetDef
      Default value of CapMapCharacterSet property. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • TimeoutDef

      public int TimeoutDef
      Default value of Timeout property. Default: 1000 (1 second). Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SystemVideoSaveBuffersDef

      public int SystemVideoSaveBuffersDef
      Default value of SystemVideoSaveBuffers property. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • SystemClocksDef

      public int SystemClocksDef
      Default value of SystemClocks property. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapMapCharacterSet

      public boolean CapMapCharacterSet
      UPOS property CapMapCharacterSet.

    • CapTransactionDef

      public boolean CapTransactionDef
      Default value of CapTransaction property. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapTransaction

      public boolean CapTransaction
      UPOS property CapTransaction.

    • EventType

      public int EventType
      UPOS property EventType.

    • MapCharacterSet

      public boolean MapCharacterSet
      UPOS property MapCharacterSet.

    • SystemClocks

      public int SystemClocks
      UPOS property SystemClocks.

    • SystemVideoSaveBuffers

      public int SystemVideoSaveBuffers
      UPOS property SystemVideoSaveBuffers.

    • Timeout

      public int Timeout
      UPOS property Timeout.

    • UnitsOnline

      public int UnitsOnline
      UPOS property UnitsOnline.

  • Constructor Details

    • RemoteOrderDisplayProperties

      public RemoteOrderDisplayProperties​(int dev)
      Constructor.
      Parameters:
      dev - Device index

  • Method Details

    • copyOut

      public void copyOut()
      Copies all properties to the property set belonging to this object.

    • copyIn

      public void copyIn()
      Retrieves all properties from the property set this object belongs to.

    • unitsToFirstIndex

      public int unitsToFirstIndex​(int units)
      Returns the lowest index of a unit specified by the given bitmask.
      Parameters:
      units - A bitmask specifying one or more display units.
      Returns:
      The lowest index where (units & (1 << index)) != 0.

    • initOnOpen

      public void initOnOpen()
      Description copied from class: JposCommonProperties
      Initialization of properties that must be initialized during open.
      Overrides:
      initOnOpen in class JposCommonProperties

    • initOnFirstEnable

      public boolean initOnFirstEnable()
      Description copied from class: JposCommonProperties
      Initialize properties that must be initialized whenever the device will be enabled the first time-
      Overrides:
      initOnFirstEnable in class JposCommonProperties
      Returns:
      Returns true in case of first enable.

    • newJposOutputRequest

      public JposOutputRequest newJposOutputRequest()
      Description copied from interface: JposBaseInterface
      Class factory for JposOutputRequests.
      Specified by:
      newJposOutputRequest in interface JposBaseInterface
      Overrides:
      newJposOutputRequest in class JposCommonProperties
      Returns:
      A new instance of JposOutputRequest or a derived class.

    • autoToneDuration

      public void autoToneDuration​(int duration) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      autoToneDuration in interface RemoteOrderDisplayInterface
      Parameters:
      duration - New AutoToneDuration value
      Throws:
      jpos.JposException - If an error occurs

    • autoToneFrequency

      public void autoToneFrequency​(int frequency) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      autoToneFrequency in interface RemoteOrderDisplayInterface
      Parameters:
      frequency - New AutoToneFrequency value
      Throws:
      jpos.JposException - If an error occurs

    • currentUnitID

      public void currentUnitID​(int unit) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      currentUnitID in interface RemoteOrderDisplayInterface
      Parameters:
      unit - New CurrentUnitID value
      Throws:
      jpos.JposException - If an error occurs

    • eventType

      public void eventType​(int type) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.

      -
      -
      Specified by:
      eventType in interface RemoteOrderDisplayInterface
      Parameters:
      type - New EventType value
      Throws:
      jpos.JposException - If an error occurs

    • mapCharacterSet

      public void mapCharacterSet​(boolean map) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      mapCharacterSet in interface RemoteOrderDisplayInterface
      Parameters:
      map - New MapCharacterSet value
      Throws:
      jpos.JposException - If an error occurs

    • timeout

      public void timeout​(int milliseconds) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      timeout in interface RemoteOrderDisplayInterface
      Parameters:
      milliseconds - New Timeout value
      Throws:
      jpos.JposException - If an error occurs

    • videoMode

      public void videoMode​(int mode) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      videoMode in interface RemoteOrderDisplayInterface
      Parameters:
      mode - New video mode value
      Throws:
      jpos.JposException - If an error occurs

    • controlClock

      public 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
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      controlClock in interface RemoteOrderDisplayInterface
      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

      public void controlCursor​(int units, int function) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      controlCursor in interface RemoteOrderDisplayInterface
      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

      public void freeVideoRegion​(int units, int bufferId) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      freeVideoRegion in interface RemoteOrderDisplayInterface
      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

      public void resetVideo​(int units) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      resetVideo in interface RemoteOrderDisplayInterface
      Parameters:
      units - Bitwise mask indicating which video unit(s) to operate on.
      Throws:
      jpos.JposException - For details, see UPOS method ResetVideo.

    • selectChararacterSet

      public void selectChararacterSet​(int units, int characterSet) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      selectChararacterSet in interface RemoteOrderDisplayInterface
      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

      public void setCursor​(int units, int row, int column) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      setCursor in interface RemoteOrderDisplayInterface
      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

      public ClearVideo clearVideo​(int units, int attribute) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      clearVideo in interface RemoteOrderDisplayInterface
      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

      public void clearVideo​(ClearVideo request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      clearVideo in interface RemoteOrderDisplayInterface
      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

      public ClearVideoRegion clearVideoRegion​(int units, int row, int column, int height, int width, int attribute) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      clearVideoRegion in interface RemoteOrderDisplayInterface
      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

      public void clearVideoRegion​(ClearVideoRegion request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      clearVideoRegion in interface RemoteOrderDisplayInterface
      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

      public CopyVideoRegion copyVideoRegion​(int units, int row, int column, int height, int width, int targetRow, int targetColumn) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      copyVideoRegion in interface RemoteOrderDisplayInterface
      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

      public void copyVideoRegion​(CopyVideoRegion request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      copyVideoRegion in interface RemoteOrderDisplayInterface
      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

      public DisplayData displayData​(int units, int row, int column, int attribute, String data) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      displayData in interface RemoteOrderDisplayInterface
      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

      public void displayData​(DisplayData request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      displayData in interface RemoteOrderDisplayInterface
      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

      public DrawBox drawBox​(int units, int row, int column, int height, int width, int attribute, int bordertype) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      drawBox in interface RemoteOrderDisplayInterface
      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

      public void drawBox​(DrawBox request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      drawBox in interface RemoteOrderDisplayInterface
      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

      public RestoreVideoRegion restoreVideoRegion​(int units, int targetRow, int targetColumn, int bufferId) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      restoreVideoRegion in interface RemoteOrderDisplayInterface
      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

      public void restoreVideoRegion​(RestoreVideoRegion request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      restoreVideoRegion in interface RemoteOrderDisplayInterface
      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

      public SaveVideoRegion saveVideoRegion​(int units, int row, int column, int height, int width, int bufferId) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      saveVideoRegion in interface RemoteOrderDisplayInterface
      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

      public void saveVideoRegion​(SaveVideoRegion request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      saveVideoRegion in interface RemoteOrderDisplayInterface
      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

      public TransactionDisplay transactionDisplay​(int units, int function) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      transactionDisplay in interface RemoteOrderDisplayInterface
      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

      public void transactionDisplay​(TransactionDisplay request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      transactionDisplay in interface RemoteOrderDisplayInterface
      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

      public UpdateVideoRegionAttribute updateVideoRegionAttribute​(int units, int function, int row, int column, int height, int width, int attribute) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      updateVideoRegionAttribute in interface RemoteOrderDisplayInterface
      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

      public void updateVideoRegionAttribute​(UpdateVideoRegionAttribute request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      updateVideoRegionAttribute in interface RemoteOrderDisplayInterface
      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

      public VideoSound videoSound​(int units, int frequency, int duration, int numberOfCycles, int interSoundWait) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      videoSound in interface RemoteOrderDisplayInterface
      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

      public void videoSound​(VideoSound request) throws jpos.JposException
      Description copied from interface: RemoteOrderDisplayInterface
      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.
      Specified by:
      videoSound in interface RemoteOrderDisplayInterface
      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.