|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A FunctionCodeDefinition
is a simple data object to contain information
about a function code used by a POS Sales application.
A function code is typically associated with a key on the
POS keyboard and is used to indicate a specific function
(e.g. TOTAL) or to initiate input (e.g. ENTER or CLEAR).
Method Summary | |
---|---|
int |
getDataLengthMaximum()
Returns the maximum length for the data using information in the input state table |
int |
getDataLengthMinimum()
Returns the minimum length for the data using information in the input state table |
int |
getDataValueMaximum()
Returns the maximum value for the data using information in the input state table |
int |
getDataValueMinimum()
Returns the minimum value for the data using information in the input state table |
int |
getHighRange()
If this function code defines a range of values, gets the high end value. |
int |
getId()
Returns the function code identifier. |
int |
getLowRange()
If this function code defines a range of values, gets the low end value. |
int |
getStateID()
Returns id of POS State this function code belongs to, or zero if none. |
boolean |
hasDataLengthSet()
Indicates if data length is available in the table. |
boolean |
hasDataValueSet()
Indicates if data value is set in the table. |
boolean |
isClearKey()
Indicates if this function code is a clear key. |
boolean |
isDataAllowed()
Indicates if data is allowed for this function code. |
boolean |
isDataDisplayed()
Indicates if the data for this function code should be displayed on the 2x20 display. |
boolean |
isDataOptional()
Indicates if data is optional for this function code. |
boolean |
isDataPrecedesFunctionCode()
Indicates if data should precede this function code. |
boolean |
isDataRequired()
Indicates if data is required for this function code. |
boolean |
isEligibleForSave()
Indicates whether this function code is eligible to be saved during processing. |
boolean |
isKeyedLabelMayPrecede()
Indicates if a keyed label may precede this function code. |
boolean |
isKeyRange()
Indicates if this function code is a range of values. |
boolean |
isManagersKeyRequired()
Indicates if a manager's key is required. |
boolean |
isMotorKey()
Indicates if the function key is a motor key. |
void |
setClearKey(boolean value)
Set Is this function code a clear key. |
void |
setDataAllowed(boolean value)
Set Is data allowed for this function code |
void |
setDataDisplayed(boolean value)
Set if the data for this function code should be displayed on the 2x20 display. |
void |
setDataLengthMaximum(int value)
Sets the maximum length for the data using information in the input state table. |
void |
setDataLengthMinimum(int value)
Sets the minimum length for the data using information in the input state table. |
void |
setDataLengthSet(boolean value)
Set if data length is available in the table. |
void |
setDataOptional(boolean value)
Set Is data optional for this function code |
void |
setDataPrecedesFunctionCode(boolean value)
Set true if data should precede this function code. |
void |
setDataRequired(boolean value)
Set Is data required for this function code. |
void |
setDataValueMaximum(int value)
Sets the maximum value for the data using information in the input state table. |
void |
setDataValueMinimum(int value)
Sets the minimum value for the data using information in the input state table. |
void |
setDataValueSet(boolean value)
Set if data value range is set in the table. |
void |
setEligibleForSave(boolean value)
Set whether this function code is eligible to be saved during processing. |
void |
setHighRange(int value)
If this function code defines a range of values, sets the high end value. |
void |
setId(int value)
Sets this function codes identifier. |
void |
setKeyedLabelMayPrecede(boolean value)
Set true if a keyed label may precede this function code. |
void |
setKeyRange(boolean value)
Set Is this function code a range of values. |
void |
setLowRange(int value)
If this function code defines a range of values, sets the low end value. |
void |
setManagersKeyRequired(boolean value)
Set if a manager's key is required. |
void |
setMotorKey(boolean value)
Set Is the function key a motor key, pressing a motor key sends the input sequence to the application. |
void |
setStateID(int value)
Sets the id of state this function code belongs to, or zero if none. |
Method Detail |
public int getId()
isKeyRange()
public boolean isDataRequired()
public boolean isDataAllowed()
public boolean isDataOptional()
public int getStateID()
StateDefinition
public boolean isMotorKey()
public boolean isClearKey()
public boolean isKeyedLabelMayPrecede()
public boolean isDataPrecedesFunctionCode()
public boolean isKeyRange()
public int getLowRange()
isKeyRange()
public int getHighRange()
isKeyRange()
public boolean isManagersKeyRequired()
public int getDataLengthMaximum()
public int getDataLengthMinimum()
public int getDataValueMaximum()
public int getDataValueMinimum()
public boolean hasDataValueSet()
public boolean hasDataLengthSet()
public boolean isDataDisplayed()
public boolean isEligibleForSave()
public void setId(int value)
value
- function code identifierpublic void setDataRequired(boolean value)
value
- the boolean to be setpublic void setDataAllowed(boolean value)
value
- the boolean to be setpublic void setDataOptional(boolean value)
public void setStateID(int value)
value
- state IDpublic void setMotorKey(boolean value)
value
- the boolean to be setpublic void setClearKey(boolean value)
value
- the boolean to be setpublic void setKeyedLabelMayPrecede(boolean value)
value
- the boolean to be setpublic void setDataPrecedesFunctionCode(boolean value)
value
- the boolean to be setpublic void setKeyRange(boolean value)
value
- the boolean to be setpublic void setLowRange(int value)
value
- low range valuepublic void setHighRange(int value)
value
- high range valuepublic void setManagersKeyRequired(boolean value)
value
- the boolean to be setpublic void setDataLengthMaximum(int value)
value
- maximum data lengthpublic void setDataLengthMinimum(int value)
value
- minimum data lengthpublic void setDataValueMaximum(int value)
value
- maximum data valuepublic void setDataValueMinimum(int value)
value
- minimum data valuepublic void setDataValueSet(boolean value)
value
- the boolean to be setpublic void setDataLengthSet(boolean value)
value
- the boolean to be setpublic void setDataDisplayed(boolean value)
value
- the boolean to be setpublic void setEligibleForSave(boolean value)
value
- the boolean to be set
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |