Package de.gmxhome.conrad.jpos.jpos_base.posprinter

Interface POSPrinterInterface

All Superinterfaces:
JposBaseInterface
All Known Implementing Classes:
POSPrinter, POSPrinterProperties
public interface POSPrinterInterface extends JposBaseInterface
Interface for methods that implement property setter and method calls for the POSPrinter device category. For details about properties, methods and method parameters, see UPOS specification, chapter POS Printer. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

  • Method Details

    • cartridgeNotify

      void cartridgeNotify​(int notify) throws jpos.JposException
      Final part of setting CartridgeNotify. 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 disabled,
      • CapJrnCartridgeSensor, CapRecCartridgeSensor or CapSlpCartridgeSensor is not 0,
      • The new value is one of the predefined values,
      • internal property AllowAlwaysSetProperties is true or notify equals the previous value of CartridgeNotify.
      Parameters:
      notify - New CartridgeNotify value
      Throws:
      jpos.JposException - If an error occurs

    • characterSet

      void characterSet​(int i) throws jpos.JposException
      Final part of setting CharacterSet. 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,
      • CapJrnCartridgeSensor, CapRecCartridgeSensor or CapSlpCartridgeSensor is not 0,
      • The new value is one of the values specified in CharacterSetList.
      Parameters:
      i - New character set value
      Throws:
      jpos.JposException - If an error occurs

    • jrnCurrentCartridge

      void jrnCurrentCartridge​(int i) throws jpos.JposException
      Final part of setting JrnCurrentCartridge. 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,
      • CapJrnPresent is true: New value is 0,
      • CapJrnPresent is false: New value is one of the cartridge values specified in CapJrnColor.
      Parameters:
      i - New color value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLetterQuality

      void jrnLetterQuality​(boolean i) throws jpos.JposException
      Final part of setting JrnLetterQuality. 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,
      • CapJrnPresent is true.
      Parameters:
      i - New JrnLetterQuality value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLineChars

      void jrnLineChars​(int i) throws jpos.JposException
      Final part of setting JrnLineChars. 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,
      • CapJrnPresent is true,
      • The new value is ≥ 0 and ≤ the maximum value specified in JrnLineCharsList.
      Parameters:
      i - New JrnLineChars value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLineHeight

      void jrnLineHeight​(int i) throws jpos.JposException
      Final part of setting JrnLineHeight. 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,
      • CapJrnPresent is true.
      Parameters:
      i - New JrnLineHeight value
      Throws:
      jpos.JposException - If an error occurs

    • jrnLineSpacing

      void jrnLineSpacing​(int i) throws jpos.JposException
      Final part of setting JrnLineSpacing. 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,
      • CapJrnPresent is true.
      Parameters:
      i - New JrnLineSpacing value
      Throws:
      jpos.JposException - If an error occurs

    • mapCharacterSet

      void mapCharacterSet​(boolean i) throws jpos.JposException
      Final part of setting MapCharacterSet. 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,
      • CapMapCharacterSet is true or the new value is false.
      Parameters:
      i - New MapCharacterSet value
      Throws:
      jpos.JposException - If an error occurs

    • mapMode

      void mapMode​(int i) throws jpos.JposException
      Final part of setting MapMode. 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 value is one of MM_DOTS, MM_TWIPS, MM_ENGLISH or MM_METRIC.
      Parameters:
      i - New MapMode value
      Throws:
      jpos.JposException - If an error occurs

    • pageModeHorizontalPosition

      void pageModeHorizontalPosition​(int i) throws jpos.JposException
      Final part of setting PageModeHorizontalPosition. 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,
      • PageModeStation is not 0.
      Parameters:
      i - New PageModeHorizontalPosition value
      Throws:
      jpos.JposException - If an error occurs

    • pageModePrintArea

      void pageModePrintArea​(String i) throws jpos.JposException
      Final part of setting PageModePrintArea. 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,
      • PageModeStation is not 0,
      • The new value consists of 4 non-negative values,
      • The area does not exceed the paper width specified by RecLineWidth or SlpLineWidth,
      • If PageModeStation = S_SLIP and SlpMaxLines > 0, the area does not exceed the paper height specified by SlpLineHeight and SlpMaxLines.
      Parameters:
      i - New PageModePrintArea value
      Throws:
      jpos.JposException - If an error occurs

    • pageModePrintDirection

      void pageModePrintDirection​(int i) throws jpos.JposException
      Final part of setting PageModePrintDirection. 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,
      • PageModeStation is not 0,
      • The new value is one of PD_TOP_TO_BOTTOM, PD_BOTTOM_TO_TOP, PD_RIGHT_TO_LEFT or PD_LEFT_TO_RIGHT.
      Parameters:
      i - New PageModePrintDirection value
      Throws:
      jpos.JposException - If an error occurs

    • pageModeStation

      void pageModeStation​(int i) throws jpos.JposException
      Final part of setting PageModeStation. 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,
      • New PageModeStation value is S_RECEIPT or S_SLIP,
      • The selected station supports page mode (CapRecPageMode or CapSlpPageMode is true).
      Parameters:
      i - New PageModeStation value
      Throws:
      jpos.JposException - If an error occurs

    • pageModeVerticalPosition

      void pageModeVerticalPosition​(int i) throws jpos.JposException
      Final part of setting PageModeVerticalPosition. 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,
      • PageModeStation is not 0.
      Parameters:
      i - New PageModeVerticalPosition value
      Throws:
      jpos.JposException - If an error occurs

    • recCurrentCartridge

      void recCurrentCartridge​(int i) throws jpos.JposException
      Final part of setting RecCurrentCartridge. 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,
      • CapRecPresent is true: New value is 0,
      • CapRecPresent is false: New value is one of the cartridge values specified in CapRecColor.
      Parameters:
      i - New color value
      Throws:
      jpos.JposException - If an error occurs

    • recLetterQuality

      void recLetterQuality​(boolean i) throws jpos.JposException
      Final part of setting RecLetterQuality. 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,
      • CapRecPresent is true.
      Parameters:
      i - New RecLetterQuality value
      Throws:
      jpos.JposException - If an error occurs

    • recLineChars

      void recLineChars​(int i) throws jpos.JposException
      Final part of setting RecLineChars. 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,
      • CapRecPresent is true,
      • The new value is ≥ 0 and ≤ the maximum value specified in RecLineCharsList.
      Parameters:
      i - New RecLineChars value
      Throws:
      jpos.JposException - If an error occurs

    • recLineHeight

      void recLineHeight​(int i) throws jpos.JposException
      Final part of setting RecLineHeight. 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,
      • CapRecPresent is true.
      Parameters:
      i - New RecLineHeight value
      Throws:
      jpos.JposException - If an error occurs

    • recLineSpacing

      void recLineSpacing​(int i) throws jpos.JposException
      Final part of setting RecLineSpacing. 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,
      • CapRecPresent is true.
      Parameters:
      i - New RecLineSpacing value
      Throws:
      jpos.JposException - If an error occurs

    • rotateSpecial

      void rotateSpecial​(int special) throws jpos.JposException
      Final part of setting RotateSpecial. 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 not closed,
      • CapRecBarCode or CapSlpBarCode is true,
      • internal property AllowAlwaysSetProperties is true or special equals the previous value of RotateSpecial.
      Parameters:
      special - New RotateSpecial value
      Throws:
      jpos.JposException - If an error occurs

    • slpCurrentCartridge

      void slpCurrentCartridge​(int i) throws jpos.JposException
      Final part of setting SlpCurrentCartridge. 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,
      • CapSlpPresent is true: New value is 0,
      • CapSlpPresent is false: New value is one of the cartridge values specified in CapSlpColor.
      Parameters:
      i - New color value
      Throws:
      jpos.JposException - If an error occurs

    • slpLetterQuality

      void slpLetterQuality​(boolean i) throws jpos.JposException
      Final part of setting SlpLetterQuality. 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,
      • CapSlpPresent is true.
      Parameters:
      i - New SlpLetterQuality value
      Throws:
      jpos.JposException - If an error occurs

    • slpLineChars

      void slpLineChars​(int i) throws jpos.JposException
      Final part of setting SlpLineChars. 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,
      • CapSlpPresent is true,
      • The new value is ≥ 0 and ≤ the maximum value specified in SlpLineCharsList.
      Parameters:
      i - New SlpLineChars value
      Throws:
      jpos.JposException - If an error occurs

    • slpLineHeight

      void slpLineHeight​(int i) throws jpos.JposException
      Final part of setting SlpLineHeight. 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,
      • CapSlpPresent is true.
      Parameters:
      i - New SlpLineHeight value
      Throws:
      jpos.JposException - If an error occurs

    • slpLineSpacing

      void slpLineSpacing​(int i) throws jpos.JposException
      Final part of setting SlpLineSpacing. 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,
      • CapSlpPresent is true.
      Parameters:
      i - New SlpLineSpacing value
      Throws:
      jpos.JposException - If an error occurs

    • beginInsertion

      void beginInsertion​(int timeout) throws jpos.JposException
      Final part of BeginInsertion method. 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,
      • CapSlpPresent is true,
      • Asynchronous output or error handling is in progress,
      • The timeout is ≥ 0 or JPOS_FOREVER.
      If the service enters insertion mode successfully after BeginInsertion failed, e.g. due to a timeout condition during delayed asynchronous insertion handling, property InsertionMode must be set to true by the specific service implementation to avoid EndInsertion to fail.
      Parameters:
      timeout - See UPOS specification, method BeginInsertion.
      Throws:
      jpos.JposException - See UPOS specification, method DisplayText.

    • beginRemoval

      void beginRemoval​(int timeout) throws jpos.JposException
      Final part of BeginRemoval method. 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,
      • CapSlpPresent is true,
      • Asynchronous output or error handling is not in progress,
      • The timeout is ≥ 0 or JPOS_FOREVER.
      If the service enters removal mode successfully after BeginRemoval failed, e.g. due to a timeout condition during delayed asynchronous removal handling, property RemovalMode must be set to true by the specific service implementation to avoid EndRemoval to fail.
      Parameters:
      timeout - See UPOS specification, method BeginRemoval.
      Throws:
      jpos.JposException - See UPOS specification, method DisplayText.

    • changePrintSide

      void changePrintSide​(int side) throws jpos.JposException
      Final part of ChangePrintSide method. 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,
      • CapSlpPresent and CapSlpBothSidesPrint are true,
      • Asynchronous output or error handling is not in progress,
      • The new side value is PS_OPPOSITE, PS_SIDE1 or PS_SIDE2.
      Parameters:
      side - See UPOS specification, method ChangePrintSide.
      Throws:
      jpos.JposException - See UPOS specification, method DisplayText.

    • clearPrintArea

      void clearPrintArea() throws jpos.JposException
      Final part of ClearPrintArea method. 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,
      • PageModeStation in not 0.
      Throws:
      jpos.JposException - See UPOS specification, method ClearPrintArea.

    • endInsertion

      void endInsertion() throws jpos.JposException
      Final part of EndInsertion method. 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,
      • CapSlpPresent is true,
      • Device is not in insertion mode,
      • Asynchronous output or error handling is not in progress.
      Throws:
      jpos.JposException - See UPOS specification, method EndInsertion.

    • endRemoval

      void endRemoval() throws jpos.JposException
      Final part of EndRemoval method. 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,
      • CapSlpPresent is true,
      • Device is not in removal mode,
      • Asynchronous output or error handling is not in progress.
      Throws:
      jpos.JposException - See UPOS specification, method EndRemoval.

    • printImmediate

      PrintImmediate printImmediate​(int station, String data) throws jpos.JposException
      Validation part of PrintImmediate method. For details, see UPOS specification. 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 (high-priority) execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • Selected station is S_JOURNAL, S_RECEIPT or S_SLIP,
      • The cover is closed, paper present, head ready and cartridge neither empty nor removed.
      If the service supports page mode but does not support immediate printing in page mode, this method must be overwritten. In this case, it must throw E_ILLEGAL if called in page mode. Keep in mind: Since PrintImmediate prints always synchronously, but page mode printing will start after leaving page mode, PrintImmediate prints outside page mode before page mode printing starts. This is also the case in sideways print mode.
      Parameters:
      station - See UPOS specification, method PrintImmediate.
      data - Print data. See UPOS specification, method PrintImmediate.
      Returns:
      PrintImmediate object for use in final part.
      Throws:
      jpos.JposException - See UPOS specification, method PrintImmediate.

    • setBitmap

      void setBitmap​(int bitmapNumber, int station, String fileName, int width, int alignment) throws jpos.JposException
      Final part of SetBitmap method. 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,
      • bitmapNumber is between 1 and 20,
      • station is S_RECEIPT or S_SLIP,
      • selected station and bitmap printing on selected station supported,
      • fileName is not null,
      • width is BM_ASIS or > 0,
      • alignment is BM_LEFT, BM_CENTER, BM_RIGHT or ≥ 0.
      Parameters:
      bitmapNumber - See UPOS specification, method SetBitmap.
      station - See UPOS specification, method SetBitmap.
      fileName - See UPOS specification, method SetBitmap.
      width - See UPOS specification, method SetBitmap.
      alignment - See UPOS specification, method SetBitmap.
      Throws:
      jpos.JposException - See UPOS specification, method SetBitmap.

    • setLogo

      void setLogo​(int location, String data) throws jpos.JposException
      Final part of SetLogo method. 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,
      • Selected location is L_TOP or L_BOTTOM,
      • data is not null.
      Parameters:
      location - See UPOS specification, method SetLogo.
      data - See UPOS specification, method SetLogo.
      Throws:
      jpos.JposException - See UPOS specification, method SetLogo.

    • validateData

      void validateData​(int station, String data) throws jpos.JposException
      Final part of ValidateData method. 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,
      • station is S_JOURNAL, S_RECEIPT or S_SLIP.
      This method will be called before data will be checked using the methods validateData with POSPrinterService.PrintDataPart, objects as second parameter. Since these methods should check everything that must be checked, it should not be necessary to overwrite this method. However, if a service overwrites this method, it may throw a JposException with error code 0 to signal that successful validation has been completed and calling validateData with POSPrinterService.PrintDataPart objects representing data shall be suppressed. Otherwise, this method can be used to initialize the implementation object to handle dependencies between all following data parts.
      Parameters:
      station - See UPOS specification, method ValidateData.
      data - Print data. See UPOS specification, method ValidateData.
      Throws:
      jpos.JposException - See UPOS specification, method ValidateData.

    • validateData

      @Deprecated void validateData​(int station, POSPrinterService.PrintDataPart data) throws jpos.JposException
      Deprecated.
      Validate character or escape sequence. Usually, this method simply calls the validation method of the given PrintDataPart object.
      This method is deprecaded now. It is recommended to use the validateData method of data instead.
      Parameters:
      station - POSPrinter station, one of S_JOURNAL, S_RECEIPT or S_SLIP.
      data - Any object derived from PrintDataPart.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.PrintData data) throws jpos.JposException
      Validate printable character sequence. ESC sequences, CR and LF have been filtered out. Default behavior is that all other characters with character code ≤ 0x20 are invalid. If a service should support more characters, this method must be overwritten.
      Keep in mind that data may contain an empty string. In that case, it marks the end of printable data in cases where the last character was a CR to support post-validation of CR.
      Parameters:
      station - POSPrinter station, one of S_JOURNAL, S_RECEIPT or S_SLIP.
      data - Data to be printed.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.ControlChar ctrl) throws jpos.JposException
      Validate control character. One of CR or LF. Default behavior is that both characters are valid. CR will be passed to ValidateData only once for any sequence of multiple CR in the original data stream and only if LF is neither the previous nor the following character. However, even if the printer supports CR, CR might be valid behind or in case of a following escape sequence.
      Parameters:
      station - POSPrinter station, one of S_JOURNAL, S_RECEIPT or S_SLIP.
      ctrl - ControlChar object, representing CR or LF.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscCut esc) throws jpos.JposException
      Validate cut sequence. For details, see UPOS specification of ESC|[#][x]P. Default behavior is that a service supports only full cut and no cut (CP_FULLCUT and 0 percent). If a service supports more values, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • Capability CapXxxPapercut is true,
      • EscCut attribute Stamp is false or CapXxxStamp is true.
      Parameters:
      station - S_RECEIPT.
      esc - EscCut object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscRuledLine esc) throws jpos.JposException
      Validate ruled line escape sequence. For details, see UPOS specification of ESC|*#dL. All parameters have been checked for plausibility before entering this method as described for each parameter. Can be overwritten by service implementations. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • The LineDirection attribute is valid in combination with the corresponding capability CapXxxRuledLine,
      • The LineWidth attribute is > 0,
      • The LineStyle attribute is one of LS_SINGLE_SOLID_LINE, LS_DOUBLE_SOLID_LINE, LS_BROKEN_LINE or LS_CHAIN_LINE,
      • The LineColor attribute is one of the colors represented by the bits set in the corresponding CapXxxColor capability,
      • The PositionList attribute conforms to the UPOS specification, method DrawRuledLine. Values have been checked against 0 and XxxLineWidth.
      The default implementation is that ruled lines are not supported. If a service supports more values, this method must be overwritten.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscRuledLine object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscNormalize esc) throws jpos.JposException
      Validate normalize escape sequence. For details, see UPOS specification of ESC|N. Should always be valid. Can be overwritten by service implementations. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscNormalize object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscLogo esc) throws jpos.JposException
      Validate logo sequence. For details, see UPOS specification of ESC|xL. The default behavior is to assume that requests to print a logo are always valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscLogo object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscStamp esc) throws jpos.JposException
      Validate stamp sequence. For details, see UPOS specification of ESC|sL. The corresponding capability (CapRecStamp) has been checked and station is S_RECEIPT. The default behavior is to assume that requests to stamp are always valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • CapXxxStanp is true.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscStamp object containing the sequemnce attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscBitmap esc) throws jpos.JposException
      Validate bitmap sequence. For details, see UPOS specification of ESC|#B. Default behavior is that all bitmap numbers are valid if the corresponding capability for the specified printer station is true. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • CapXxxBitmap is true,
      • EscBitmap attribute Number is > 0 and ≤ 20.
      Parameters:
      station - A valid printer station, S_RECEIPT or S_SLIP.
      esc - EscBitmap object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscFeed esc) throws jpos.JposException
      Validate feed sequence. For details, see UPOS specification of ESC|[#]xF. Default behavior is that all count values are valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscFeed object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscEmbedded esc) throws jpos.JposException
      Validate embedded data sequence. For details, see UPOS specification of ESC|[*]#E. Default behavior is that the given sequence is valid. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscEmbedded object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscBarcode esc) throws jpos.JposException
      Validate barcode sequence. For details, see UPOS specification of ESC|[*]#R. A service implementation should check the validity of symbology, height and text position and whether all character in code can be printed using the selected symbology. For example, if symbology is BCS_UPCA, the code must consist only of numeric characters, the length must be 6, 7, 11 or 12 and in case of 7 or 12, the last digit must be a valid check digit. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • CapXxxBarCode is true,
      • EscBarcode attribute Symbology is ≥ BCS_UPCA (which is the smallest valid symbology value),
      • EscBarcode attribute Height is > 0,
      • EscBarcode attribute Width is > 0 and ≤ XxxLineWidth,
      • EscCarcode attribute TextPosition is one of BC_TEXT_ABOVE, BC_TEXT_BELOW or BC_TEXT_NONE.
      Parameters:
      station - A valid printer station, S_RECEIPT or S_SLIP.
      esc - EscBarcode object containing sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscFontTypeface esc) throws jpos.JposException
      Validate font typeface selection sequence. For details, see UPOS specification of ESC|#fT. Default behavior is to support all type fonts specified in FontTypefaceList for all printer stations. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • EscFontTypeface attribute is between 0 and the number of type face names specified in FontTypefaceList.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscFontTypeface object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscAlignment esc) throws jpos.JposException
      Validate alignment sequence. For details, see UPOS specification of ESC|xA. Default behavior is that the service supports left, centered and right aligned text. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Parameters:
      station - A valid printer station, S_RECEIPT, S_JOURNAL or S_SLIP.
      esc - EscAlignment object that contains the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscScale esc) throws jpos.JposException
      Validate print size sequence. For details, see UPOS specification for ESC|xC, ESC|#hC or ESC|#vC. Default behavior is only support for scale = 1 and 2 if the corresponding capabilities for width and height of the specified station are true. If a service supports more scales, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscScale attribute ScaleValue is 2, CapXxxDhigh, CapXxxDwide or CapXxxDwideDhigh is true if the corresponding EscScale attribute(s) ScaleHorizontal and / or ScaleVertical is / are true.
      Parameters:
      station - Valid print station
      esc - EscScale object that holds the sequence specific attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscSimple esc) throws jpos.JposException
      Validate attribute setting sequences. For details, see UPOS specification for ESC|[!]bC, ESC|[!]iC, ESC|[!]rvC, ESC|[!]tbC and ESC|[!]tpC. The default behavior is that reverse video, superscript and subscript printing is not supported and resetting an attribute is not supported, too. If a printer supports these attributes, this method must be overwritten.
      The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscSimple attributes Bold and Activate are true, CapXxxBold is true,
      • If EscSimple attributes Italic and Activate are true, CapXxxItalic is true.
      Parameters:
      station - Print station, in case of bold ant italic validated.
      esc - Object holding data of simple esc sequence
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscLine esc) throws jpos.JposException
      Validate combined line printing sequence. For details, see UPOS specification for ESC|[!][#]uC and ESC|[!][#]stC. Default behavior is no support for strike-through and thickness of 1 dot for underline is supported. If a service supports strike-through or another thickness, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscLine attribute Underline and Activate are true, CapXxxUnderline is true.
      Parameters:
      station - Valid print station
      esc - EscLine object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscColor esc) throws jpos.JposException
      Validate color sequences. For details, see UPOS specification for ESC|[#]rC and ESC|[#]fC. Default behavior is that the service supports all colors specified in the 2Color capability of the specified printer station, but no RGB color settings. If a service supports RGB colors, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid,
      • If EscColor attribute Rgb is true, attribute Color has a decimal value of the form rrrgggbbb, where rrr, ggg and bbb are values between 0 and 255 (inclusive),
      • If EscColor attribute Rgbis false, attribute Color is one of the color values that form CapXxx2Color.
      Parameters:
      station - Valid printer station
      esc - EscColor object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscShade esc) throws jpos.JposException
      Validate shading sequence. For details, see UPOS specification of ESC|[#]sC. Default is no support of shading. Therefore all values other then -1 (default) and 0 are not supported. If a service supports shading, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Parameters:
      station - POSPrinter station.
      esc - EscShade object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • validateData

      void validateData​(int station, POSPrinterService.EscUnknown esc) throws jpos.JposException
      Validate unknown sequence. Default is no support. If a device supports further sequences, this method must be overwritten. The following plausibility checks will be made before this method will be called:
      • The printer station is valid.
      Parameters:
      station - POSPrinter station.
      esc - EscUnknown object containing the sequence attributes.
      Throws:
      jpos.JposException - For details, see UPOS method ValidateData.

    • getLogoData

      POSPrinterService.PrintDataPart[] getLogoData​(boolean top)
      This method will be called whenever print data contain a logo print sequence ESC|tL or ESC|bL. Since it is possible that logos can be changed between the print call and execution of methods for asynchronous print, e.g. when transaction printing will be used, data describing the logo must be retrieved by POSPrinterService whenever an EscLogo object is generated. Every POSPrinter service implementation must overwrite this method because only the specific service stores information about the logo data. However, logo data are of type POSPrinterService.PrintDataPart[], where POSPrinterService.PrintDataPart is one of the objects supported by validateData(int, POSPrinterService.PrintDataPart). As default, this method returns an empty list of objects.
      Parameters:
      top - Specifies which logo data shall be filled, true for top logo, false for bottom logo.
      Returns:
      POSPrinterService.PrintDataPart array containing logo data. Array is empty if the requested logo has not been set.

    • cutPaper

      CutPaper cutPaper​(int percentage) throws jpos.JposException
      Validation part of CutPaper method. For details, see UPOS specification. 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,
      • CapRecPresent and CapRecPapercut are true,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational.
      Parameters:
      percentage - See UPOS specification, method CutPaper.
      Returns:
      CutPaper object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method CutPaper.

    • cutPaper

      void cutPaper​(CutPaper request) throws jpos.JposException
      Final part of CutPaper method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a CutPaper 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:
      • Receipt paper is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by CutPaper.
      Throws:
      jpos.JposException - For details, see UPOS method CutPaper.

    • drawRuledLine

      DrawRuledLine drawRuledLine​(int station, String positionList, int lineDirection, int lineWidth, int lineStyle, int lineColor) throws jpos.JposException
      Validation part of DrawRuledLine method. For details, see UPOS specification. 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,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational.
      • neither transaction mode nor vertical print mode or page mode is active for the specified station,
      • station, lineDirection, lineWidth, lineStyle, lineColor and positionList have been validated with validateRuledLine.
      Parameters:
      station - POSPrinter station.
      positionList - Position list.
      lineDirection - Line direction.
      lineWidth - Line width in dots.
      lineStyle - Line stype.
      lineColor - Line color.
      Returns:
      DrawRuledLine object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method DrawRuledLine.

    • drawRuledLine

      void drawRuledLine​(DrawRuledLine request) throws jpos.JposException
      Final part of DrawRuledLine method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a DrawRuledLine 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:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by DrawRuledLine.
      Throws:
      jpos.JposException - For details, see UPOS method DrawRuledLine.

    • markFeed

      MarkFeed markFeed​(int type) throws jpos.JposException
      Validation part of MarkFeed method. For details, see UPOS specification. 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,
      • neither transaction mode nor vertical print mode or page mode is active,
      • CapRecPresent is true and CapRecMarkFeed is not 0,
      • type is MF_TO_TAKEUP, MF_TO_CUTTER, MF_TO_CURRENT_TOF or MF_TO_NEXT_TOF,
      • CapRecMarkFeed ANDed with type is non-zero,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational.
      Parameters:
      type - type of mark sensed paper handling. See UPOS specification for method MarkFeed
      Returns:
      MarkFeed object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method MarkFeed.

    • markFeed

      void markFeed​(MarkFeed request) throws jpos.JposException
      Final part of MarkFeed method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a MarkFeed 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:
      • Receipt paper is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by MarkFeed.
      Throws:
      jpos.JposException - For details, see UPOS method MarkFeed.

    • printBarCode

      PrintBarCode printBarCode​(int station, String data, int symbology, int height, int width, int alignment, int textPosition) throws jpos.JposException
      Validation part of PrintBarCode method. For details, see UPOS specification. 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,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station, data, symbology, height, width, alignment and textPosition have been validated with validateBarcode.
      If a service supports upside down printing, this method must be overwritten. It must at least be check whether the service is inside upside down printing mode without activated rotated barcode printing.
      Parameters:
      station - Print station, see UPOS method PrintBarCode.
      data - String to be bar coded, see UPOS method PrintBarCode.
      symbology - Symbol type to be used, see UPOS method PrintBarCode.
      height - Bar code height, see UPOS method PrintBarCode.
      width - Bar code width, see UPOS method PrintBarCode.
      alignment - Bar code alignment, see UPOS method PrintBarCode.
      textPosition - HRI text position, see UPOS method PrintBarCode.
      Returns:
      PrintBarCode object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBarCode.

    • printBarCode

      void printBarCode​(PrintBarCode request) throws jpos.JposException
      Final part of PrintBarCode method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintBarCode 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:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintBarCode.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBarCode.

    • printBitmap

      PrintBitmap printBitmap​(int station, String fileName, int width, int alignment) throws jpos.JposException
      Validation part of PrintBitmap method. For details, see UPOS specification. 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,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station is valid (S_RECEIPT or S_SLIP and CapXxxBitmap and CapXxxPresent are true),
      • fileName is not null,
      • width is BM_ASIS or a value > 0,
      • alignment is one of BM_LEFT, BM_CENTER, BM_RIGHT or a positive value.
      If a service supports bitmap printing, this method must be overwritten. It must at least be check whether the fileName points to a valid bitmap file. In addition, if the service supports upside down printing, it must check whether the service is inside upside down printing mode without activated rotated bitmap printing.
      Parameters:
      station - Print station, see UPOS method PrintBitmap.
      fileName - Bitmap file name, see UPOS method PrintBitmap.
      width - Width, see UPOS method PrintBitmap.
      alignment - Alignment, see UPOS method PrintBitmap.
      Returns:
      PrintBitmap object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBitmap.

    • printBitmap

      void printBitmap​(PrintBitmap request) throws jpos.JposException
      Final part of PrintBitmap method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintBitmap 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:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintBitmap.
      Throws:
      jpos.JposException - For details, see UPOS method PrintBitmap.

    • printMemoryBitmap

      PrintMemoryBitmap printMemoryBitmap​(int station, byte[] data, int type, int width, int alignment) throws jpos.JposException
      Validation part of PrintMemoryBitmap method. For details, see UPOS specification. 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,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station is valid (S_RECEIPT or S_SLIP and CapXxxBitmap and CapXxxPresent are true),
      • data is not null,
      • type is one of BMT_BMP, BMT_JPEG or BMT_GIF,
      • width is BM_ASIS or a value > 0,
      • alignment is one of BM_LEFT, BM_CENTER, BM_RIGHT or a positive value.
      If a service supports bitmap printing, this method must be overwritten. It must at least be check whether data is a byte array that matches the given bitmap format. In addition, if the service supports upside down printing, it must check whether the service is inside upside down printing mode without activated rotated bitmap printing.
      Parameters:
      station - Print station, see UPOS method PrintMemoryBitmap.
      data - Bitmap data, see UPOS method PrintBitmap.
      type - Bitmap format, see UPOS method PrintBitmap.
      width - Width, see UPOS method PrintMemoryBitmap.
      alignment - Alignment, see UPOS method PrintMemoryBitmap.
      Returns:
      PrintMemoryBitmap object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintMemoryBitmap.

    • printMemoryBitmap

      void printMemoryBitmap​(PrintMemoryBitmap request) throws jpos.JposException
      Final part of PrintMemoryBitmap method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintMemoryBitmap 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:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintMemoryBitmap.
      Throws:
      jpos.JposException - For details, see UPOS method PrintMemoryBitmap.

    • printNormal

      PrintNormal printNormal​(int station, String data) throws jpos.JposException
      Validation part of PrintNormal method. For details, see UPOS specification. 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,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational,
      • station is valid (S_JOURNAL, S_RECEIPT or S_SLIP and the corresponding CapXxxPresent is true),
      • data is not null.
      Parameters:
      station - Print station, see UPOS method PrintNormal.
      data - Print data. See UPOS method PrintNormal.
      Returns:
      PrintNormal object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintNormal.

    • printNormal

      void printNormal​(PrintNormal request) throws jpos.JposException
      Final part of PrintNormal method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintNormal 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:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintNormal.
      Throws:
      jpos.JposException - For details, see UPOS method PrintNormal.

    • printTwoNormal

      PrintTwoNormal printTwoNormal​(int stations, String data1, String data2) throws jpos.JposException
      Validation part of PrintTwoNormal method. For details, see UPOS specification. 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,
      • stations is valid (S_JOURNAL_RECEIPT, S_JOURNAL_SLIP, S_RECEIPT_SLIP, TWO_RECEIPT_JOURNAL, TWO_SLIP_JOURNAL or TWO_SLIP_RECEIPT and the corresponding CapConcurrentXxxYyy property is true),
      • data1 and data2 are not null,
      • Non of the two print stations is in page mode, sideways print mode or transaction mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Parameters:
      stations - Print stations, see UPOS method PrintTwoNormal.
      data1 - Print data for first or both stations, see UPOS method PrintTwoNormal.
      data2 - Print data for second station or empty string, see UPOS method PrintTwoNormal.
      Returns:
      PrintTwoNormal object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PrintTwoNormal.

    • printTwoNormal

      void printTwoNormal​(PrintTwoNormal request) throws jpos.JposException
      Final part of PrintTwoNormal method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PrintTwoNormal 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:
      • The stations specified by request.getStation() are present.
      • Covers are closed.
      • If present, cartridges are operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PrintTwoNormal.
      Throws:
      jpos.JposException - For details, see UPOS method PrintTwoNormal.

    • transactionPrint

      TransactionPrint transactionPrint​(int station, int control) throws jpos.JposException
      Validation part of TransactionPrint method. For details, see UPOS specification. 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,
      • station is valid (S_JOURNAL, S_RECEIPT or S_SLIP),
      • control is one of TP_NORMAL or TP_TRANSACTION,
      • control is TP_NORMAL if and only if the service is in transaction mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Parameters:
      station - Print station, see UPOS method TransactionPrint.
      control - Control, see UPOS method TransactionPrint.
      Returns:
      TransactionPrint object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method TransactionPrint.

    • transactionPrint

      void transactionPrint​(TransactionPrint request) throws jpos.JposException
      Final part of TransactionPrint method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a TransactionPrint 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:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by TransactionPrint.
      Throws:
      jpos.JposException - For details, see UPOS method TransactionPrint.

    • rotatePrint

      RotatePrint rotatePrint​(int station, int rotation) throws jpos.JposException
      Validation part of RotatePrint method. For details, see UPOS specification. 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,
      • station is valid (S_RECEIPT or S_SLIP),
      • rotation contains one of the rotation values (RP_RIGHT90, RP_LEFT90 or RP_ROTATE180) or is RP_NORMAL,
      • If not RP_NORMAL: The capability corresponding to station (CapXxxRight90, CapXxxLeft90, CapRotate180) is true and the station is not in sideways printing mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Parameters:
      station - Print station, see UPOS method RotatePrint.
      rotation - Rotation, see UPOS method RotatePrint.
      Returns:
      RotatePrint object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method RotatePrint.

    • rotatePrint

      void rotatePrint​(RotatePrint request) throws jpos.JposException
      Final part of RotatePrint method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a RotatePrint 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:
      • The station specified by request.getStation() is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by RotatePrint.
      Throws:
      jpos.JposException - For details, see UPOS method RotatePrint.

    • pageModePrint

      PageModePrint pageModePrint​(int control) throws jpos.JposException
      Validation part of PageModePrint method. For details, see UPOS specification. 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,
      • PageModeStation is valid (S_RECEIPT or S_SLIP and the correcponding capability CapXxxPageMode is true),
      • control is one of PM_PAGE_MODE, PM_PRINT_SAVE, PM_NORMAL or PM_CANCEL,
      • If PM_PAGE_MODE: The station is not in page mode,
      • If not PM_PAGE_MODE: The station is in page mode,
      • If AsyncMode is false: State is S_IDLE, paper present, cover closed and if present, cartridge is operational for both stations.
      Parameters:
      control - Control, see UPOS method PageModePrint.
      Returns:
      PageModePrint object for use in final part.
      Throws:
      jpos.JposException - For details, see UPOS method PageModePrint.

    • pageModePrint

      void pageModePrint​(PageModePrint request) throws jpos.JposException
      Final part of PageModePrint method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a PageModePrint 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:
      • The station specified by PageModeStation is present.
      • Cover is closed.
      • If present, cartridge is operational.
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by PageModePrint.
      Throws:
      jpos.JposException - For details, see UPOS method PageModePrint.