com.ibm.retail.AEF.data
Interface FunctionCodeDefinition

All Superinterfaces:
java.io.Serializable

public interface FunctionCodeDefinition
extends java.io.Serializable

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

getId

public int getId()
Returns the function code identifier.

Returns:
identifier
See Also:
isKeyRange()

isDataRequired

public boolean isDataRequired()
Indicates if data is required for this function code.

Returns:
true if data is required

isDataAllowed

public boolean isDataAllowed()
Indicates if data is allowed for this function code.

Returns:
true if data is allowed

isDataOptional

public boolean isDataOptional()
Indicates if data is optional for this function code.

Returns:
true if data is optional

getStateID

public int getStateID()
Returns id of POS State this function code belongs to, or zero if none.

Returns:
int
See Also:
StateDefinition

isMotorKey

public boolean isMotorKey()
Indicates if the function key is a motor key. Pressing a motor key sends the input sequence to the application.

Returns:
true if this function code is a motor key

isClearKey

public boolean isClearKey()
Indicates if this function code is a clear key.

Returns:
true if this function code is the clear key

isKeyedLabelMayPrecede

public boolean isKeyedLabelMayPrecede()
Indicates if a keyed label may precede this function code.

Returns:
true if a keyed label may precede, false otherwise

isDataPrecedesFunctionCode

public boolean isDataPrecedesFunctionCode()
Indicates if data should precede this function code.

Returns:
true if data should precede this function code

isKeyRange

public boolean isKeyRange()
Indicates if this function code is a range of values.

Returns:
returns true if this is a range of keys

getLowRange

public int getLowRange()
If this function code defines a range of values, gets the low end value.

Returns:
range value
See Also:
isKeyRange()

getHighRange

public int getHighRange()
If this function code defines a range of values, gets the high end value.

Returns:
range value
See Also:
isKeyRange()

isManagersKeyRequired

public boolean isManagersKeyRequired()
Indicates if a manager's key is required.

Returns:
true if a manager's key is required for this function code

getDataLengthMaximum

public int getDataLengthMaximum()
Returns the maximum length for the data using information in the input state table

Returns:
maximum data length

getDataLengthMinimum

public int getDataLengthMinimum()
Returns the minimum length for the data using information in the input state table

Returns:
minimum data length

getDataValueMaximum

public int getDataValueMaximum()
Returns the maximum value for the data using information in the input state table

Returns:
maximum data value

getDataValueMinimum

public int getDataValueMinimum()
Returns the minimum value for the data using information in the input state table

Returns:
minimum data value

hasDataValueSet

public boolean hasDataValueSet()
Indicates if data value is set in the table.

Returns:
true if a data value range is set in the table

hasDataLengthSet

public boolean hasDataLengthSet()
Indicates if data length is available in the table.

Returns:
true if a data length range is set in the table

isDataDisplayed

public boolean isDataDisplayed()
Indicates if the data for this function code should be displayed on the 2x20 display.

Returns:
true if data is displayed

isEligibleForSave

public boolean isEligibleForSave()
Indicates whether this function code is eligible to be saved during processing.

Returns:
true if eligible for save

setId

public void setId(int value)
Sets this function codes identifier.

Parameters:
value - function code identifier

setDataRequired

public void setDataRequired(boolean value)
Set Is data required for this function code.

Parameters:
value - the boolean to be set

setDataAllowed

public void setDataAllowed(boolean value)
Set Is data allowed for this function code

Parameters:
value - the boolean to be set

setDataOptional

public void setDataOptional(boolean value)
Set Is data optional for this function code


setStateID

public void setStateID(int value)
Sets the id of state this function code belongs to, or zero if none.

Parameters:
value - state ID

setMotorKey

public void setMotorKey(boolean value)
Set Is the function key a motor key, pressing a motor key sends the input sequence to the application.

Parameters:
value - the boolean to be set

setClearKey

public void setClearKey(boolean value)
Set Is this function code a clear key.

Parameters:
value - the boolean to be set

setKeyedLabelMayPrecede

public void setKeyedLabelMayPrecede(boolean value)
Set true if a keyed label may precede this function code.

Parameters:
value - the boolean to be set

setDataPrecedesFunctionCode

public void setDataPrecedesFunctionCode(boolean value)
Set true if data should precede this function code.

Parameters:
value - the boolean to be set

setKeyRange

public void setKeyRange(boolean value)
Set Is this function code a range of values.

Parameters:
value - the boolean to be set

setLowRange

public void setLowRange(int value)
If this function code defines a range of values, sets the low end value.

Parameters:
value - low range value

setHighRange

public void setHighRange(int value)
If this function code defines a range of values, sets the high end value.

Parameters:
value - high range value

setManagersKeyRequired

public void setManagersKeyRequired(boolean value)
Set if a manager's key is required.

Parameters:
value - the boolean to be set

setDataLengthMaximum

public void setDataLengthMaximum(int value)
Sets the maximum length for the data using information in the input state table.

Parameters:
value - maximum data length

setDataLengthMinimum

public void setDataLengthMinimum(int value)
Sets the minimum length for the data using information in the input state table.

Parameters:
value - minimum data length

setDataValueMaximum

public void setDataValueMaximum(int value)
Sets the maximum value for the data using information in the input state table.

Parameters:
value - maximum data value

setDataValueMinimum

public void setDataValueMinimum(int value)
Sets the minimum value for the data using information in the input state table.

Parameters:
value - minimum data value

setDataValueSet

public void setDataValueSet(boolean value)
Set if data value range is set in the table.

Parameters:
value - the boolean to be set

setDataLengthSet

public void setDataLengthSet(boolean value)
Set if data length is available in the table.

Parameters:
value - the boolean to be set

setDataDisplayed

public void setDataDisplayed(boolean value)
Set if the data for this function code should be displayed on the 2x20 display.

Parameters:
value - the boolean to be set

setEligibleForSave

public void setEligibleForSave(boolean value)
Set whether this function code is eligible to be saved during processing.

Parameters:
value - the boolean to be set


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004