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

Class RemoteOrderDisplayService

java.lang.Object

de.gmxhome.conrad.jpos.jpos_base.JposBase

de.gmxhome.conrad.jpos.jpos_base.remoteorderdisplay.RemoteOrderDisplayService

All Implemented Interfaces:

jpos.loader.JposServiceInstance, jpos.services.BaseService, jpos.services.RemoteOrderDisplayService110, jpos.services.RemoteOrderDisplayService111, jpos.services.RemoteOrderDisplayService112, jpos.services.RemoteOrderDisplayService113, jpos.services.RemoteOrderDisplayService114, jpos.services.RemoteOrderDisplayService115, jpos.services.RemoteOrderDisplayService116, jpos.services.RemoteOrderDisplayService13, jpos.services.RemoteOrderDisplayService14, jpos.services.RemoteOrderDisplayService15, jpos.services.RemoteOrderDisplayService16, jpos.services.RemoteOrderDisplayService17, jpos.services.RemoteOrderDisplayService18, jpos.services.RemoteOrderDisplayService19

public class RemoteOrderDisplayService
extends JposBase
implements jpos.services.RemoteOrderDisplayService116

RemoteOrderDisplay service implementation. For more details about getter, setter and method implementations, see JposBase.

Field Summary

Fields

Modifier and Type	Field	Description
RemoteOrderDisplayInterface	RemoteOrderDisplayInterface	Instance of a class implementing the RemoteOrderDisplayInterface for remote order display specific setter and method calls bound to the property set.

Fields inherited from class de.gmxhome.conrad.jpos.jpos_base.JposBase

Device, DeviceInterface, Props

Constructor Summary

Constructors

Constructor	Description
RemoteOrderDisplayService(RemoteOrderDisplayProperties props, JposDevice device)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	checkEnabled()	Checks whether the device is enabled.
void	checkFirstEnabled()	Checks whether the device has just been enabled once.
void	checkOpened()	Checks whether the device has been opened.
void	checkSync(boolean condition, int units, int error, int ext, String message)	If in synchronous mode, check condition and if true, sets error properties and throws JposException.
void	clearInput()	Common method clearInput, see UPOS specification
void	clearOutput()	Common method clearOutput, se UPOS specification
void	clearVideo(int units, int attribute)
void	clearVideoRegion(int units, int row, int column, int height, int width, int attribute)
void	controlClock(int Units, int function, int clockid, int hour, int minute, int second, int row, int column, int attribute, int mode)
void	controlCursor(int units, int function)
void	copyVideoRegion(int units, int row, int column, int height, int width, int targetRow, int targetColumn)
void	displayData(int units, int row, int column, int attribute, String data)
void	drawBox(int units, int row, int column, int height, int width, int attribute, int borderType)
void	freeVideoRegion(int units, int bufferId)
boolean	getAsyncMode()	Get common property AsyncMode, see UPOS specification
int	getAutoToneDuration()
int	getAutoToneFrequency()
boolean	getCapMapCharacterSet()
boolean	getCapSelectCharacterSet()
boolean	getCapTone()
boolean	getCapTouch()
boolean	getCapTransaction()
int	getCharacterSet()
String	getCharacterSetList()
int	getClocks()
int	getCurrentUnitID()
int	getDataCount()	Get common property DataCount, see UPOS specification
String	getErrorString()
int	getErrorUnits()
String	getEventString()
int	getEventType()
int	getEventUnitID()
int	getEventUnits()
boolean	getMapCharacterSet()
int	getSystemClocks()
int	getSystemVideoSaveBuffers()
int	getTimeout()
int	getUnitsOnline()
int	getVideoDataCount()
int	getVideoMode()
String	getVideoModesList()
int	getVideoSaveBuffers()
void	resetVideo(int units)
void	restoreVideoRegion(int units, int targetRow, int targetColumn, int bufferId)
void	saveVideoRegion(int units, int row, int column, int height, int width, int bufferId)
void	selectChararacterSet(int units, int characterSet)
void	setAsyncMode(boolean b)	Get common property AsyncMode, see UPOS specification
void	setAutoToneDuration(int i)
void	setAutoToneFrequency(int i)
void	setCurrentUnitID(int i)
void	setCursor(int units, int row, int column)
void	setEventType(int i)
void	setMapCharacterSet(boolean b)
void	setTimeout(int i)
void	setVideoMode(int i)
void	transactionDisplay(int units, int function)
void	updateVideoRegionAttribute(int units, int function, int row, int column, int height, int width, int attribute)
int	validateBufferID(int units, int id)	Checks if id is a valid buffer id for all specified units.
int	validateClockID(int bits, int id)	Checks if id is a valid clock id for all units specified by bits.
int	validateCoordinates(int bits, int row, int column)	Checks whether the given coordinates are valid for the specified units.
int	validateTone(int bits)	Checks if CapTone is true for all units specified by bits.
void	videoSound(int units, int frequency, int duration, int NumberOfCycles, int interSountWait)

Methods inherited from class de.gmxhome.conrad.jpos.jpos_base.JposBase

callNowOrLater, check, check, check, check, checkBusy, checkClaimed, checkEnabledUnclaimed, checkHealth, checkNoChangedOrClaimed, claim, clearInputProperties, close, compareFirmwareVersion, deepToString, deleteInstance, directIO, getAutoDisable, getCapCompareFirmwareVersion, getCapPowerReporting, getCapStatisticsReporting, getCapUpdateFirmware, getCapUpdateStatistics, getCheckHealthText, getClaimed, getDataEventEnabled, getDeviceEnabled, getDeviceServiceDescription, getDeviceServiceVersion, getFreezeEvents, getOutputID, getPhysicalDeviceDescription, getPhysicalDeviceName, getPowerNotify, getPowerState, getPropertyString, getState, logAsyncCall, logCall, logCall, logGet, logGet, logPreCall, logPreCall, logPreSet, logSet, open, release, removeOuterArraySpecifier, resetStatistics, retrieveStatistics, setAutoDisable, setDataEventEnabled, setDeviceEnabled, setFreezeEvents, setPowerNotify, signalRelease, startClaiming, updateFirmware, updateStatistics

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jpos.services.BaseService

checkHealth, claim, close, directIO, getCheckHealthText, getClaimed, getDeviceEnabled, getDeviceServiceDescription, getDeviceServiceVersion, getFreezeEvents, getPhysicalDeviceDescription, getPhysicalDeviceName, getState, open, release, setDeviceEnabled, setFreezeEvents

Methods inherited from interface jpos.loader.JposServiceInstance

deleteInstance

Methods inherited from interface jpos.services.RemoteOrderDisplayService13

getCapPowerReporting, getDataEventEnabled, getOutputID, getPowerNotify, getPowerState, setDataEventEnabled, setPowerNotify

Methods inherited from interface jpos.services.RemoteOrderDisplayService18

getCapStatisticsReporting, getCapUpdateStatistics, resetStatistics, retrieveStatistics, updateStatistics

Methods inherited from interface jpos.services.RemoteOrderDisplayService19

compareFirmwareVersion, getCapCompareFirmwareVersion, getCapUpdateFirmware, updateFirmware

Field Details

RemoteOrderDisplayInterface

public RemoteOrderDisplayInterface RemoteOrderDisplayInterface

Instance of a class implementing the RemoteOrderDisplayInterface for remote order display specific setter and method calls bound to the property set. Almost always the same object as Data.

Constructor Details

RemoteOrderDisplayService

public RemoteOrderDisplayService(RemoteOrderDisplayProperties props,
 JposDevice device)

Constructor. Stores given property set and device implementation object.

Parameters:

props - Property set.

device - Device implementation object.

Method Details

getAsyncMode

public boolean getAsyncMode()
                     throws jpos.JposException

Description copied from class: JposBase

Get common property AsyncMode, see UPOS specification

Specified by:

getAsyncMode in interface jpos.services.RemoteOrderDisplayService13

Overrides:

getAsyncMode in class JposBase

Returns:

property value

Throws:

jpos.JposException - See UPOS specification, property

setAsyncMode

public void setAsyncMode(boolean b)
                  throws jpos.JposException

Description copied from class: JposBase

Get common property AsyncMode, see UPOS specification

Specified by:

setAsyncMode in interface jpos.services.RemoteOrderDisplayService13

Overrides:

setAsyncMode in class JposBase

Parameters:

b - New property value

Throws:

jpos.JposException - See UPOS specification, property PowerNotify

getAutoToneDuration

public int getAutoToneDuration()
                        throws jpos.JposException

Specified by:

getAutoToneDuration in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

setAutoToneDuration

public void setAutoToneDuration(int i)
                         throws jpos.JposException

Specified by:

setAutoToneDuration in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getAutoToneFrequency

public int getAutoToneFrequency()
                         throws jpos.JposException

Specified by:

getAutoToneFrequency in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

setAutoToneFrequency

public void setAutoToneFrequency(int i)
                          throws jpos.JposException

Specified by:

setAutoToneFrequency in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getCapMapCharacterSet

public boolean getCapMapCharacterSet()
                              throws jpos.JposException

Specified by:

getCapMapCharacterSet in interface jpos.services.RemoteOrderDisplayService17

Throws:

jpos.JposException

getCapSelectCharacterSet

public boolean getCapSelectCharacterSet()
                                 throws jpos.JposException

Specified by:

getCapSelectCharacterSet in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getCapTone

public boolean getCapTone()
                   throws jpos.JposException

Specified by:

getCapTone in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getCapTouch

public boolean getCapTouch()
                    throws jpos.JposException

Specified by:

getCapTouch in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getCapTransaction

public boolean getCapTransaction()
                          throws jpos.JposException

Specified by:

getCapTransaction in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getCharacterSet

public int getCharacterSet()
                    throws jpos.JposException

Specified by:

getCharacterSet in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getCharacterSetList

public String getCharacterSetList()
                           throws jpos.JposException

Specified by:

getCharacterSetList in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getClocks

public int getClocks()
              throws jpos.JposException

Specified by:

getClocks in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getCurrentUnitID

public int getCurrentUnitID()
                     throws jpos.JposException

Specified by:

getCurrentUnitID in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

setCurrentUnitID

public void setCurrentUnitID(int i)
                      throws jpos.JposException

Specified by:

setCurrentUnitID in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getDataCount

public int getDataCount()
                 throws jpos.JposException

Description copied from class: JposBase

Get common property DataCount, see UPOS specification

Specified by:

getDataCount in interface jpos.services.RemoteOrderDisplayService13

Overrides:

getDataCount in class JposBase

Returns:

property value

Throws:

jpos.JposException - See UPOS specification, property DataCount

getErrorString

public String getErrorString()
                      throws jpos.JposException

Specified by:

getErrorString in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getErrorUnits

public int getErrorUnits()
                  throws jpos.JposException

Specified by:

getErrorUnits in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getEventString

public String getEventString()
                      throws jpos.JposException

Specified by:

getEventString in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getEventType

public int getEventType()
                 throws jpos.JposException

Specified by:

getEventType in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

setEventType

public void setEventType(int i)
                  throws jpos.JposException

Specified by:

setEventType in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getEventUnitID

public int getEventUnitID()
                   throws jpos.JposException

Specified by:

getEventUnitID in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getEventUnits

public int getEventUnits()
                  throws jpos.JposException

Specified by:

getEventUnits in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getMapCharacterSet

public boolean getMapCharacterSet()
                           throws jpos.JposException

Specified by:

getMapCharacterSet in interface jpos.services.RemoteOrderDisplayService17

Throws:

jpos.JposException

setMapCharacterSet

public void setMapCharacterSet(boolean b)
                        throws jpos.JposException

Specified by:

setMapCharacterSet in interface jpos.services.RemoteOrderDisplayService17

Throws:

jpos.JposException

getSystemClocks

public int getSystemClocks()
                    throws jpos.JposException

Specified by:

getSystemClocks in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getSystemVideoSaveBuffers

public int getSystemVideoSaveBuffers()
                              throws jpos.JposException

Specified by:

getSystemVideoSaveBuffers in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getTimeout

public int getTimeout()
               throws jpos.JposException

Specified by:

getTimeout in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

setTimeout

public void setTimeout(int i)
                throws jpos.JposException

Specified by:

setTimeout in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getUnitsOnline

public int getUnitsOnline()
                   throws jpos.JposException

Specified by:

getUnitsOnline in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getVideoDataCount

public int getVideoDataCount()
                      throws jpos.JposException

Specified by:

getVideoDataCount in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getVideoMode

public int getVideoMode()
                 throws jpos.JposException

Specified by:

getVideoMode in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

setVideoMode

public void setVideoMode(int i)
                  throws jpos.JposException

Specified by:

setVideoMode in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getVideoModesList

public String getVideoModesList()
                         throws jpos.JposException

Specified by:

getVideoModesList in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

getVideoSaveBuffers

public int getVideoSaveBuffers()
                        throws jpos.JposException

Specified by:

getVideoSaveBuffers in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

clearInput

public void clearInput()
                throws jpos.JposException

Description copied from class: JposBase

Common method clearInput, see UPOS specification

Specified by:

clearInput in interface jpos.services.RemoteOrderDisplayService13

Overrides:

clearInput in class JposBase

Throws:

jpos.JposException - see UPOS specification

clearOutput

public void clearOutput()
                 throws jpos.JposException

Description copied from class: JposBase

Common method clearOutput, se UPOS specification

Specified by:

clearOutput in interface jpos.services.RemoteOrderDisplayService13

Overrides:

clearOutput in class JposBase

Throws:

jpos.JposException - See UPOS specification, method clearOutput

validateCoordinates

public int validateCoordinates(int bits,
 int row,
 int column)

Checks whether the given coordinates are valid for the specified units.

Parameters:

bits - Unit to be checked.

row - Character row of coordinate.

column - Character column of coordinate.

Returns:

Bit mask, 1 for every requested unit where row and column are not valid coordinates.

validateClockID

public int validateClockID(int bits,
 int id)

Checks if id is a valid clock id for all units specified by bits.

Parameters:

bits - Bit mask specifying all requested units.

id - Clock ID to be checked.

Returns:

Bit mask, 1 for every requested unit where id is not a valid clock ID.

checkSync

public void checkSync(boolean condition,
 int units,
 int error,
 int ext,
 String message)
               throws jpos.JposException

If in synchronous mode, check condition and if true, sets error properties and throws JposException.

Parameters:

condition - Error condition

units - Units to be filled in ErrorUnits

error - Error code

ext - Extended error code

message - Error message, same message for ErrorString and JposException

Throws:

jpos.JposException - If Error condition is true

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

Specified by:

controlClock in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

controlCursor

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

Specified by:

controlCursor in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

validateBufferID

public int validateBufferID(int units,
 int id)

Checks if id is a valid buffer id for all specified units.

Parameters:

units - Bit mask specifying all requested units.

id - Buffer ID to be checked.

Returns:

Bit mask, 1 for every requested unit where id is not a valid buffer ID.

freeVideoRegion

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

Specified by:

freeVideoRegion in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

resetVideo

public void resetVideo(int units)
                throws jpos.JposException

Specified by:

resetVideo in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

selectChararacterSet

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

Specified by:

selectChararacterSet in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

setCursor

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

Specified by:

setCursor in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

clearVideo

public void clearVideo(int units,
 int attribute)
                throws jpos.JposException

Specified by:

clearVideo in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

clearVideoRegion

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

Specified by:

clearVideoRegion in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

copyVideoRegion

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

Specified by:

copyVideoRegion in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

displayData

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

Specified by:

displayData in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

drawBox

public void drawBox(int units,
 int row,
 int column,
 int height,
 int width,
 int attribute,
 int borderType)
             throws jpos.JposException

Specified by:

drawBox in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

restoreVideoRegion

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

Specified by:

restoreVideoRegion in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

saveVideoRegion

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

Specified by:

saveVideoRegion in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

transactionDisplay

public void transactionDisplay(int units,
 int function)
                        throws jpos.JposException

Specified by:

transactionDisplay in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

updateVideoRegionAttribute

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

Specified by:

updateVideoRegionAttribute in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

validateTone

public int validateTone(int bits)

Checks if CapTone is true for all units specified by bits.

Parameters:

bits - Bit mask specifying all units to be checked.

Returns:

Bit mask, 1 for every requested unit where CapTone is false.

videoSound

public void videoSound(int units,
 int frequency,
 int duration,
 int NumberOfCycles,
 int interSountWait)
                throws jpos.JposException

Specified by:

videoSound in interface jpos.services.RemoteOrderDisplayService13

Throws:

jpos.JposException

checkFirstEnabled

public void checkFirstEnabled()
                       throws jpos.JposException

Description copied from class: JposBase

Checks whether the device has just been enabled once. If not, throws a JposException with an error code and message that describe the state of the device.

Overrides:

checkFirstEnabled in class JposBase

Throws:

jpos.JposException - Will be thrown whenever the device has never been enabled.

checkOpened

public void checkOpened()
                 throws jpos.JposException

Description copied from class: JposBase

Checks whether the device has been opened. If not, a JposException will be thrown with the corresponding error code.

Overrides:

checkOpened in class JposBase

Throws:

jpos.JposException - Will be thrown whenever the device has not been opened or has been closed.

checkEnabled

public void checkEnabled()
                  throws jpos.JposException

Description copied from class: JposBase

Checks whether the device is enabled. If not, throws a JposException with an error code and message that describe the state of the device.

Overrides:

checkEnabled in class JposBase

Throws:

jpos.JposException - Will be thrown whenever the device is not enabled.