Package de.gmxhome.conrad.jpos.jpos_base.bumpbar

Interface BumpBarInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

BumpBarProperties

public interface BumpBarInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the BumpBar device category. For details about properties, methods and method parameters, see UPOS specification, chapter Bump Bar. 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.
BumpBarSound	bumpBarSound(int units, int frequency, int duration, int numberOfCycles, int interSoundWait)	Validation part of BumpBarSound method.
void	bumpBarSound(BumpBarSound request)	Final part of BumpBarSound method.
void	currentUnitID(int unit)	Final part of setting CurrentUnitID.
void	setKeyTranslation(int units, int scanCode, int logicalKey)	Final part of logical key value assignment.
void	timeout(int milliseconds)	Final part of setting Timeout.

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 unit 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 unit 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

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

setKeyTranslation

void setKeyTranslation(int units,
 int scanCode,
 int logicalKey)
                throws jpos.JposException

Final part of logical key value assignment. 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,
• At least one unit has been selected (units != 0),
• The device units specified by units are online,
• Both, scanCode and logicalKey, are within the range from 0 to 255.

Parameters:

units - Bitwise mask indicating which bump bar unit(s) to set key translation for.

scanCode - The bump bar generated key scan code. Valid values 0-255.

logicalKey - The translated logical key value. Valid values 0-255.

Throws:

jpos.JposException - If an error occurs

bumpBarSound

BumpBarSound bumpBarSound(int units,
 int frequency,
 int duration,
 int numberOfCycles,
 int interSoundWait)
                   throws jpos.JposException

Validation part of BumpBarSound 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,
• At least one unit has been selected (units != 0),
• All units specified by units are online,
• For all specified units is CapTone true,
• interSoundWait is a positive value,
• numberOfCycles is FOREVER or a positive non-zero value,
• If AsyncMode is false, numberOfCycles is not FOREVER.

Parameters:

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

frequency - Tone frequency in Hertz.

duration - Tone duration in milliseconds.

numberOfCycles - Number of cycles the tone shall be performed.

interSoundWait - Milliseconds to wait before playing the tone again.

Returns:

BumpBarSound object for use in final part.

Throws:

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

bumpBarSound

void bumpBarSound(BumpBarSound request)
           throws jpos.JposException

Final part of BumpBarSound method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a BumpBarSound 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 still online.

Parameters:

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

Throws:

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