InputData class abstract

InputData

Properties:

  • device - Logical device located on a Sale Terminal or a POI Terminal, regarding the class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer. Possible values: * CashierDisplay * CashierInput * CustomerDisplay * CustomerInput
  • infoQualify - Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer. Possible values: * CustomerAssistance * Display * Document * Error * Input * POIReplication * Receipt * Sound * Status * Voucher
  • inputCommand - Type of requested input. Can be: GetConfirmation, TextString, DigitString, DecimalString or GetMenuEntry. Possible values: * DecimalString * DigitString * GetAnyKey * GetConfirmation * GetFunctionKey * GetMenuEntry * Password * SiteManager * TextString
  • notifyCardInputFlag - Request Notification of the card entered in the POI card reader.
  • maxInputTime - Maximum input time in seconds. Limits the time to answer to an Input request message.
  • immediateResponseFlag - Indicates whether to request an Immediate response to the message without waiting for the completion of the command.
  • minLength - Minimum length of an entered string, or minimum number of entries that can be selected in a menu.
  • maxLength - Maximum length of an entered string, or maximum number of entries that can be selected in a menu.
  • maxDecimalLength - Maximum input length of the decimal part (without decimal point).
  • waitUserValidationFlag - Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command TextString, DigitString or DecimalString with MaxLength or MaxDecimalLength present in the request.
  • defaultInputString - Default string value for an input command. On the TextString, DigitString and DecimalString input commands: default string displayed on the input field before entering the string. In GetConfirmation input command: Y for yes, N for no.
  • defaultLayoutString
  • stringMask - String mask to get information requiring a specific format. For the processing of an Input command TextString, DigitString or DecimalString. Some information as date or plate number required to be entered with a certain format.
  • fromRightToLeftFlag - Indicates if the entered character has to be displayed from the right to the left of the display field.
  • maskCharactersFlag - Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).
  • beepKeyFlag - Indicates, when the user press a key, if a beep has to be generated (value True).
  • globalCorrectionFlag - Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).
  • disableCancelFlag - Indicates if the Cancel function key has to be deactivated (value True).
  • disableCorrectFlag - Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command GetConfirmation, SiteManager, or GetMenuEntry.
  • disableValidFlag - Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command GetConfirmation, SiteManager, or GetMenuEntry.
  • menuBackFlag - If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.
Annotations
  • @BuiltValue.new()

Constructors

InputData([void updates(InputDataBuilder b)])
factory

Properties

beepKeyFlag bool?
Indicates, when the user press a key, if a beep has to be generated (value True).
no setter
defaultInputString String?
Default string value for an input command. On the TextString, DigitString and DecimalString input commands: default string displayed on the input field before entering the string. In GetConfirmation input command: Y for yes, N for no.
no setter
defaultLayoutString String?
no setter
device Device
Logical device located on a Sale Terminal or a POI Terminal, regarding the class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer. Possible values: * CashierDisplay * CashierInput * CustomerDisplay * CustomerInput
no setter
disableCancelFlag bool?
Indicates if the Cancel function key has to be deactivated (value True).
no setter
disableCorrectFlag bool?
Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command GetConfirmation, SiteManager, or GetMenuEntry.
no setter
disableValidFlag bool?
Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command GetConfirmation, SiteManager, or GetMenuEntry.
no setter
fromRightToLeftFlag bool?
Indicates if the entered character has to be displayed from the right to the left of the display field.
no setter
globalCorrectionFlag bool?
Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).
no setter
hashCode int
The hash code for this object.
no setterinherited
immediateResponseFlag bool?
Indicates whether to request an Immediate response to the message without waiting for the completion of the command.
no setter
infoQualify InfoQualify
Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer. Possible values: * CustomerAssistance * Display * Document * Error * Input * POIReplication * Receipt * Sound * Status * Voucher
no setter
inputCommand InputCommand
Type of requested input. Can be: GetConfirmation, TextString, DigitString, DecimalString or GetMenuEntry. Possible values: * DecimalString * DigitString * GetAnyKey * GetConfirmation * GetFunctionKey * GetMenuEntry * Password * SiteManager * TextString
no setter
maskCharactersFlag bool?
Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).
no setter
maxDecimalLength int?
Maximum input length of the decimal part (without decimal point).
no setter
maxInputTime int?
Maximum input time in seconds. Limits the time to answer to an Input request message.
no setter
maxLength int?
Maximum length of an entered string, or maximum number of entries that can be selected in a menu.
no setter
If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.
no setter
minLength int?
Minimum length of an entered string, or minimum number of entries that can be selected in a menu.
no setter
notifyCardInputFlag bool?
Request Notification of the card entered in the POI card reader.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stringMask String?
String mask to get information requiring a specific format. For the processing of an Input command TextString, DigitString or DecimalString. Some information as date or plate number required to be entered with a certain format.
no setter
waitUserValidationFlag bool?
Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command TextString, DigitString or DecimalString with MaxLength or MaxDecimalLength present in the request.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(InputDataBuilder)) InputData
Rebuilds the instance.
inherited
toBuilder() InputDataBuilder
Converts the instance to a builder B.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

serializer → Serializer<InputData>
no setter