FiscalPacket (Java Fiscal Device API

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractFiscalPacket, HasarFiscalPacket
```
public interface FiscalPacket
extends java.io.Serializable
```
A request to or response from a fiscal device. A packet is a vector of byte arrays called fields. Fields cannot be null. Fields are accessed using a zero-based index up to getSize() - 1. All operations that set values of fields may grow the size of the vector as needed, adding empty fields if necessary.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STYLE_DOUBLE_HEIGHT` Double height text style.
`static int`	`STYLE_DOUBLE_WIDTH` Double width text style.
`static int`	`STYLE_EMPHASIZED` Emphasized text style.
`static int`	`STYLE_NORMAL` Normal text style.
`static int`	`STYLE_UNDERLINED` Underlined text style.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Remove all fields.
`void`	`clear(int field)` Replace field with empty byte array.
`java.lang.Object`	`clone()` Returns a deep copy of this packet.
`boolean`	`equals(java.lang.Object o)` Returns true if this and the specified packet have the same size and their corresponding fields have the same sequence of bytes.
`byte[]`	`get(int field)` Get the value of a field.
`java.math.BigDecimal`	`getBigDecimal(int field)` Get a numeric field as a BigDecimal.
`java.math.BigInteger`	`getBigInteger(int field)` Get a numeric field as a BigInteger.
`int`	`getByte(int field)` Get a field of 1 byte.
`int`	`getCommandCode()` Get the command code of this packet.
`byte[]`	`getCopy(int field)` Get a copy of the value of a field.
`int`	`getCopy(int field, byte[] value)` Copy at most `value.length` bytes of the value of a field to the provided array.
`int`	`getCopy(int field, byte[] value, int offset, int length)` Copy at most `length` bytes of the value of a field to the provided array.
`java.util.Date`	`getDate(int field)` Get a date field as a Date object.
`java.util.Calendar`	`getDate(int field, java.util.Calendar calendar)` Get the contents of a date field into the passed Calendar object.
`java.util.Date`	`getDateAndTime(int dateField, int timeField)` Get a date field and a time field as a Date object.
`java.util.Calendar`	`getDateAndTime(int dateField, int timeField, java.util.Calendar calendar)` Get the contents of a date field and a time field into the passed Calendar object.
`int`	`getDateDay(int field)` Get the day of month part of a date field (1 to 31).
`int`	`getDateMonth(int field)` Get the month of year part of a date field (1 to 12).
`int`	`getDateYear(int field)` Get the year part of a date field (full 4 digit value).
`double`	`getDouble(int field)` Get a numeric field as a double.
`int`	`getFiscalStatus()` Get the fiscal status of this response packet.
`float`	`getFloat(int field)` Get a numeric field as a float.
`int`	`getHex16(int field)` Get a 16-bit value from a field of 4 bytes representing the ASCII codes of the value in case insensitive hexadecimal notation, most significant nibble first.
`int`	`getInt(int field)` Get a numeric field as an integer.
`int`	`getLength(int field)` Get the length of the specified byte array.
`long`	`getLong(int field)` Get a numeric field as a long.
`int`	`getPrinterStatus()` Get the printer status of this response packet.
`int`	`getSize()` Get the number of fields.
`java.lang.String`	`getString(int field)` Get a string field.
`int`	`getStringStyle(int field)` Get the style of a string field.
`int`	`getTimeHour(int field)` Get the hour part of a time field (0 to 23).
`int`	`getTimeMinute(int field)` Get the minute part of a time field (0 to 59).
`int`	`getTimeSecond(int field)` Get the second part of a time field (0 to 59).
`void`	`set(int field, byte[] value)` Set the value of a field.
`void`	`setBigDecimal(int field, java.math.BigDecimal value)` Set a numeric field from a BigDecimal.
`void`	`setBigInteger(int field, java.math.BigInteger value)` Set a numeric field from a BigInteger.
`void`	`setByte(int field, int value)` Set a field of 1 byte.
`void`	`setCommandCode(int value)` Set the command code of this packet.
`void`	`setCopy(int field, byte[] value)` Set the value of a field to a copy of the passed value.
`void`	`setCopy(int field, byte[] value, int offset, int length)` Set the value of a field to a copy of the passed value.
`void`	`setDate(int field, java.util.Calendar calendar)` Set a date field from a Calendar object.
`void`	`setDate(int field, java.util.Date date)` Set a date field from a Date object.
`void`	`setDate(int field, int year, int month, int day)` Set a date field by specifying year (full 4 digit value), month of year (1 to 12) and day of month (1 to 31).
`void`	`setDateAndTime(int dateField, int timeField, java.util.Calendar calendar)` Set a date field and a time field from a Calendar object.
`void`	`setDateAndTime(int dateField, int timeField, java.util.Date date)` Set a date field and a time field from a Date object.
`void`	`setDateAndTime(int dateField, int timeField, int year, int month, int day, int hour, int minute, int second)` Set a date field and a time field by specifying year (full 4 digit value), month of year (1 to 12), day of month (1 to 31), hour (0 to 23), minute (0 to 59) and second (0 to 59).
`void`	`setDouble(int field, double value)` Set a numeric field from a double.
`void`	`setFiscalStatus(int value)` Set the fiscal status of this response packet.
`void`	`setFloat(int field, float value)` Set a numeric field from a float.
`void`	`setHex16(int field, int value)` Set a field of 4 bytes representing the ASCII codes of the passed value in upper-case hexadecimal notation, most significant nibble first.
`void`	`setInt(int field, int value)` Set a numeric field from an integer.
`void`	`setLong(int field, long value)` Set a numeric field from a long.
`void`	`setPrinterStatus(int value)` Set the printer status of this response packet.
`void`	`setSize(int size)` Set the number of fields.
`void`	`setString(int field, java.lang.String value)` Set a string field.
`void`	`setString(int field, java.lang.String value, int style)` Set a string field in the specified style.
`void`	`setTime(int field, int hour, int minute, int second)` Set a time field by specifying hour (0 to 23), minute (0 to 59) and second (0 to 59).
`java.lang.String`	`toASCIIString()` Returns a string representation of the packet contents as a vector of escaped ASCII strings.
`java.lang.String`	`toHexString()` Returns a string representation of the packet contents in hexadecimal notation.
`java.lang.String`	`toString()` Returns a string representation of the packet contents.

- Field Detail
  - STYLE_NORMAL
```
static final int STYLE_NORMAL
```
    Normal text style.
    
    See Also:
    Constant Field Values
  - STYLE_EMPHASIZED
```
static final int STYLE_EMPHASIZED
```
    Emphasized text style.
    
    See Also:
    Constant Field Values
  - STYLE_DOUBLE_HEIGHT
```
static final int STYLE_DOUBLE_HEIGHT
```
    Double height text style.
    
    See Also:
    Constant Field Values
  - STYLE_DOUBLE_WIDTH
```
static final int STYLE_DOUBLE_WIDTH
```
    Double width text style.
    
    See Also:
    Constant Field Values
  - STYLE_UNDERLINED
```
static final int STYLE_UNDERLINED
```
    Underlined text style.
    
    See Also:
    Constant Field Values
- Method Detail
  - equals
```
boolean equals(java.lang.Object o)
```
    Returns true if this and the specified packet have the same size and their corresponding fields have the same sequence of bytes.
    
    Overrides:
    
    equals in class java.lang.Object
  - clone
```
java.lang.Object clone()
```
    Returns a deep copy of this packet. Fields are themselves copied.
  - toString
```
java.lang.String toString()
```
    Returns a string representation of the packet contents.
    
    Overrides:
    
    toString in class java.lang.Object
  - toHexString
```
java.lang.String toHexString()
```
    Returns a string representation of the packet contents in hexadecimal notation.
  - toASCIIString
```
java.lang.String toASCIIString()
```
    Returns a string representation of the packet contents as a vector of escaped ASCII strings.
  - clear
```
void clear()
```
    Remove all fields.
  - setSize
```
void setSize(int size)
```
    Set the number of fields. Add empty fields to the end or remove fields from the end of the packet as needed.
  - getSize
```
int getSize()
```
    Get the number of fields.
  - clear
```
void clear(int field)
```
    Replace field with empty byte array.
  - set
```
void set(int field,
       byte[] value)
```
    Set the value of a field. A reference to the passed value is kept (value is not copied).
  - get
```
byte[] get(int field)
```
    Get the value of a field. A reference to the value is returned (the value is not copied).
  - getLength
```
int getLength(int field)
```
    Get the length of the specified byte array.
  - setCopy
```
void setCopy(int field,
           byte[] value)
```
    Set the value of a field to a copy of the passed value.
  - setCopy
```
void setCopy(int field,
           byte[] value,
           int offset,
           int length)
```
    Set the value of a field to a copy of the passed value.
  - getCopy
```
byte[] getCopy(int field)
```
    Get a copy of the value of a field.
  - getCopy
```
int getCopy(int field,
          byte[] value)
```
    Copy at most value.length bytes of the value of a field to the provided array.
    
    Returns:
    the real length of the field which may be more than what was actually copied.
  - getCopy
```
int getCopy(int field,
          byte[] value,
          int offset,
          int length)
```
    Copy at most length bytes of the value of a field to the provided array.
    
    Returns:
    the real length of the field which may be more than what was actually copied.
  - setString
```
void setString(int field,
             java.lang.String value)
```
    Set a string field. The style used is STYLE_NORMAL.
  - setString
```
void setString(int field,
             java.lang.String value,
             int style)
```
    Set a string field in the specified style.
  - getString
```
java.lang.String getString(int field)
```
    Get a string field.
  - getStringStyle
```
int getStringStyle(int field)
```
    Get the style of a string field.
  - setByte
```
void setByte(int field,
           int value)
```
    Set a field of 1 byte.
  - getByte
```
int getByte(int field)
```
    Get a field of 1 byte.
  - setHex16
```
void setHex16(int field,
            int value)
```
    Set a field of 4 bytes representing the ASCII codes of the passed value in upper-case hexadecimal notation, most significant nibble first. The value is truncated to 16 bits.
  - getHex16
```
int getHex16(int field)
```
    Get a 16-bit value from a field of 4 bytes representing the ASCII codes of the value in case insensitive hexadecimal notation, most significant nibble first.
  - setInt
```
void setInt(int field,
          int value)
```
    Set a numeric field from an integer.
  - getInt
```
int getInt(int field)
```
    Get a numeric field as an integer.
  - setLong
```
void setLong(int field,
           long value)
```
    Set a numeric field from a long.
  - getLong
```
long getLong(int field)
```
    Get a numeric field as a long.
  - setFloat
```
void setFloat(int field,
            float value)
```
    Set a numeric field from a float.
  - getFloat
```
float getFloat(int field)
```
    Get a numeric field as a float.
  - setDouble
```
void setDouble(int field,
             double value)
```
    Set a numeric field from a double.
  - getDouble
```
double getDouble(int field)
```
    Get a numeric field as a double.
  - setBigInteger
```
void setBigInteger(int field,
                 java.math.BigInteger value)
```
    Set a numeric field from a BigInteger.
  - getBigInteger
```
java.math.BigInteger getBigInteger(int field)
```
    Get a numeric field as a BigInteger.
  - setBigDecimal
```
void setBigDecimal(int field,
                 java.math.BigDecimal value)
```
    Set a numeric field from a BigDecimal.
  - getBigDecimal
```
java.math.BigDecimal getBigDecimal(int field)
```
    Get a numeric field as a BigDecimal.
  - setDate
```
void setDate(int field,
           int year,
           int month,
           int day)
```
    Set a date field by specifying year (full 4 digit value), month of year (1 to 12) and day of month (1 to 31).
  - getDateYear
```
int getDateYear(int field)
```
    Get the year part of a date field (full 4 digit value).
  - getDateMonth
```
int getDateMonth(int field)
```
    Get the month of year part of a date field (1 to 12).
  - getDateDay
```
int getDateDay(int field)
```
    Get the day of month part of a date field (1 to 31).
  - setTime
```
void setTime(int field,
           int hour,
           int minute,
           int second)
```
    Set a time field by specifying hour (0 to 23), minute (0 to 59) and second (0 to 59).
  - getTimeHour
```
int getTimeHour(int field)
```
    Get the hour part of a time field (0 to 23).
  - getTimeMinute
```
int getTimeMinute(int field)
```
    Get the minute part of a time field (0 to 59).
  - getTimeSecond
```
int getTimeSecond(int field)
```
    Get the second part of a time field (0 to 59).
  - setDateAndTime
```
void setDateAndTime(int dateField,
                  int timeField,
                  int year,
                  int month,
                  int day,
                  int hour,
                  int minute,
                  int second)
```
    Set a date field and a time field by specifying year (full 4 digit value), month of year (1 to 12), day of month (1 to 31), hour (0 to 23), minute (0 to 59) and second (0 to 59).
  - setDate
```
void setDate(int field,
           java.util.Date date)
```
    Set a date field from a Date object. Uses default calendar and time-zone.
  - getDate
```
java.util.Date getDate(int field)
```
    Get a date field as a Date object. Uses default calendar and time-zone.
  - setDateAndTime
```
void setDateAndTime(int dateField,
                  int timeField,
                  java.util.Date date)
```
    Set a date field and a time field from a Date object. Uses default calendar and time-zone.
  - getDateAndTime
```
java.util.Date getDateAndTime(int dateField,
                            int timeField)
```
    Get a date field and a time field as a Date object. Uses default calendar and time-zone.
  - setDate
```
void setDate(int field,
           java.util.Calendar calendar)
```
    Set a date field from a Calendar object.
  - getDate
```
java.util.Calendar getDate(int field,
                         java.util.Calendar calendar)
```
    Get the contents of a date field into the passed Calendar object.
    
    Returns:
    the passed calendar.
  - setDateAndTime
```
void setDateAndTime(int dateField,
                  int timeField,
                  java.util.Calendar calendar)
```
    Set a date field and a time field from a Calendar object.
  - getDateAndTime
```
java.util.Calendar getDateAndTime(int dateField,
                                int timeField,
                                java.util.Calendar calendar)
```
    Get the contents of a date field and a time field into the passed Calendar object.
    
    Returns:
    the passed calendar.
  - setCommandCode
```
void setCommandCode(int value)
```
    Set the command code of this packet.
  - getCommandCode
```
int getCommandCode()
```
    Get the command code of this packet.
  - setPrinterStatus
```
void setPrinterStatus(int value)
```
    Set the printer status of this response packet.
  - getPrinterStatus
```
int getPrinterStatus()
```
    Get the printer status of this response packet.
  - setFiscalStatus
```
void setFiscalStatus(int value)
```
    Set the fiscal status of this response packet.
  - getFiscalStatus
```
int getFiscalStatus()
```
    Get the fiscal status of this response packet.

Interface FiscalPacket

Field Summary

Method Summary

Field Detail

STYLE_NORMAL

STYLE_EMPHASIZED

STYLE_DOUBLE_HEIGHT

STYLE_DOUBLE_WIDTH

STYLE_UNDERLINED

Method Detail

equals

clone

toString

toHexString

toASCIIString

clear

setSize

getSize

clear

set

get

getLength

setCopy

setCopy

getCopy

getCopy

getCopy

setString

setString

getString

getStringStyle

setByte

getByte

setHex16

getHex16

setInt

getInt

setLong

getLong

setFloat

getFloat

setDouble

getDouble

setBigInteger

getBigInteger

setBigDecimal

getBigDecimal

setDate

getDateYear

getDateMonth

getDateDay

setTime

getTimeHour

getTimeMinute

getTimeSecond

setDateAndTime

setDate

getDate

setDateAndTime

getDateAndTime

setDate

getDate

setDateAndTime

getDateAndTime

setCommandCode

getCommandCode

setPrinterStatus

getPrinterStatus

setFiscalStatus

getFiscalStatus