Java for Retail POS
Programming Guide
Version 1.6 July 15, 2001
International Standard
For Implementation of POS Peripherals on a Java Based System
Java for Retail POS Committee Members:
Epson, Fujitsu Transaction Solutions Inc, Home Depot,
IBM, JCPenney, MGV, NCR, PCMS Datafit,
Research Computer Services, Sears Roebuck and Co.,
Sun Microsystems, Wincor Nixdorf
Java for Retail POS
© 2001 Java for Retail POS Committee
Programmer’s Guide
Information in this document is subject to change without notice.
JavaPOS is a trademark of Sun Microsystems, Inc.
i
Table of Contents
INTRODUCTION AND ARCHITECTURE
J
AVA
FOR
R
ETAIL
POS .......................................................................................... 1
WHAT IS JAVA FOR RETAIL POS? ................................................................... 1
B
ENEFITS
................................................................................................................ 2
D
EPENDENCIES
....................................................................................................... 2
R
ELATIONSHIP
TO
OPOS ....................................................................................... 2
W
HO
S
HOULD
R
EAD
T
HIS
D
OCUMENT
.................................................................. 3
C
HAPTER
O
VERVIEW
.............................................................................................. 4
ARCHITECTURAL OVERVIEW ......................................................................... 5
A
RCHITECTURAL
C
OMPONENTS
............................................................................. 6
DEVICE BEHAVIOR MODELS ............................................................................ 9
I
NTRODUCTION
TO
P
ROPERTIES
, M
ETHODS
,
AND
E
VENTS
.................................... 9
D
EVICE
I
NITIALIZATION
AND
F
INALIZATION
....................................................... 10
Initialization ................................................................................................... 10
Finalization .................................................................................................... 10
Summary ........................................................................................................ 11
D
EVICE
S
HARING
M
ODEL
.................................................................................... 12
Exclusive-Use Devices ................................................................................... 13
Sharable Devices ........................................................................................... 13
D
ATA
T
YPES
......................................................................................................... 14
E
XCEPTIONS
......................................................................................................... 15
ErrorCode ...................................................................................................... 16
ErrorCodeExtended ....................................................................................... 17
E
VENTS
................................................................................................................. 18
Registering for Events .................................................................................... 20
Event Delivery ................................................................................................ 20
D
EVICE
I
NPUT
M
ODEL
......................................................................................... 22
D
EVICE
O
UTPUT
M
ODELS
.................................................................................... 25
Synchronous Output ....................................................................................... 25
Asynchronous Output ..................................................................................... 25
D
EVICE
P
OWER
R
EPORTING
M
ODEL
.................................................................... 27
Model ............................................................................................................. 27
Properties ....................................................................................................... 28
Power Reporting Requirements for DeviceEnabled ...................................... 29
D
EVICE
S
TATES
.................................................................................................... 30
T
HREADS
.............................................................................................................. 31
V
ERSION
H
ANDLING
............................................................................................ 32
ii
JavaPOS for Retail POS Programming Guide
CLASSES AND INTERFACES ............................................................................ 33
S
YNOPSIS
.............................................................................................................. 33
Application ..................................................................................................... 33
Device Control ............................................................................................... 34
Device Service ................................................................................................ 34
Helper Classes ............................................................................................... 35
S
AMPLE
C
LASS
AND
I
NTERFACE
H
IERARCHIES
................................................... 36
Application ..................................................................................................... 36
Device Controls ............................................................................................. 36
Device Service ................................................................................................ 37
S
AMPLE
A
PPLICATION
C
ODE
............................................................................... 39
P
ACKAGE
S
TRUCTURE
.......................................................................................... 40
jpos ................................................................................................................. 40
jpos.events ...................................................................................................... 41
jpos.services ................................................................................................... 41
DEVICE CONTROLS ........................................................................................... 42
D
EVICE
C
ONTROL
R
ESPONSIBILITIES
................................................................... 42
D
EVICE
S
ERVICE
M
ANAGEMENT
......................................................................... 43
jpos.config/loader (JCL)
and JavaPOS Entry Registry (JER) ....................................................... 43
jpos.config/loader (JCL) Characteristics ...................................................... 43
P
ROPERTY
AND
M
ETHOD
F
ORWARDING
.............................................................. 46
E
VENT
H
ANDLING
................................................................................................ 47
Event Listeners and Event Delivery ............................................................... 47
Event Callbacks ............................................................................................. 48
V
ERSION
H
ANDLING
............................................................................................ 49
DEVICE SERVICES.............................................................................................. 51
D
EVICE
S
ERVICE
R
ESPONSIBILITIES
..................................................................... 51
P
ROPERTY
AND
M
ETHOD
P
ROCESSING
................................................................ 51
E
VENT
G
ENERATION
............................................................................................ 52
P
HYSICAL
D
EVICE
A
CCESS
.................................................................................. 52
CHAPTER 1
COMMON PROPERTIES, METHODS, AND EVENTS .................................. 53
S
UMMARY
............................................................................................................ 53
G
ENERAL
I
NFORMATION
...................................................................................... 55
P
ROPERTIES
.......................................................................................................... 56
M
ETHODS
............................................................................................................. 68
E
VENTS
................................................................................................................. 74
CHAPTER 2
BUMP BAR ............................................................................................................. 79
S
UMMARY
............................................................................................................ 79
G
ENERAL
I
NFORMATION
...................................................................................... 83
P
ROPERTIES
.......................................................................................................... 88
M
ETHODS
............................................................................................................. 94
E
VENTS
................................................................................................................. 99
iii
CHAPTER 3
CASH CHANGER ................................................................................................ 105
S
UMMARY
.......................................................................................................... 105
G
ENERAL
I
NFORMATION
.................................................................................... 108
P
ROPERTIES
........................................................................................................ 114
M
ETHODS
........................................................................................................... 126
E
VENTS
............................................................................................................... 133
CHAPTER 4
CASH DRAWER .................................................................................................. 135
S
UMMARY
.......................................................................................................... 135
G
ENERAL
I
NFORMATION
.................................................................................... 137
P
ROPERTIES
........................................................................................................ 138
M
ETHODS
........................................................................................................... 140
E
VENTS
............................................................................................................... 141
CHAPTER 5
CAT-CREDIT AUTHORIZATION TERMINAL ............................................ 143
S
UMMARY
.......................................................................................................... 143
G
ENERAL
I
NFORMATION
.................................................................................... 146
P
ROPERTIES
........................................................................................................ 153
M
ETHODS
............................................................................................................ 174
E
VENTS
............................................................................................................... 182
CHAPTER 6
COIN DISPENSER ............................................................................................... 187
S
UMMARY
........................................................................................................... 187
G
ENERAL
I
NFORMATION
.................................................................................... 190
P
ROPERTIES
........................................................................................................ 191
M
ETHODS
........................................................................................................... 193
E
VENTS
............................................................................................................... 194
CHAPTER 7
FISCAL PRINTER ............................................................................................... 197
S
UMMARY
.......................................................................................................... 197
G
ENERAL
I
NFORMATION
.................................................................................... 204
P
ROPERTIES
........................................................................................................ 219
M
ETHODS
............................................................................................................ 260
E
VENTS
............................................................................................................... 346
CHAPTER 8
HARD TOTALS ................................................................................................... 353
S
UMMARY
.......................................................................................................... 353
G
ENERAL
I
NFORMATION
..................................................................................... 357
P
ROPERTIES
........................................................................................................ 361
M
ETHODS
........................................................................................................... 364
E
VENTS
............................................................................................................... 375
