Serialized Form
|
Package com.pkrete.jsip2.exceptions |
|
Package com.pkrete.jsip2.messages |
sequence
int sequence
- Sequence number of the message (0-9)
checkSum
String checkSum
- Checksum is four ASCII charater digits representing the binary
sum of the characters included the message
code
String code
- Command identifier
institutionId
String institutionId
- Library's institution id.
transactionDate
String transactionDate
- Date and time of the request. 18-char,
fixed-length field: YYYYMMDDZZZZHHMMSS.
patronIdentifier
String patronIdentifier
- An identifying value for the patron, library card's barcode
number for example.
itemIdentifier
String itemIdentifier
- Identifying value for the item.
itemProperties
String itemProperties
- Specific item information that can be used for identifying an item,
such as item weight, size, security marker, etc.
titleIdentifier
String titleIdentifier
- Identifying value for the title.
transactionId
String transactionId
- A transaction id that is assigned by the ILS or by a payment device,
for auditing purposes to track cash flow.
currencyType
CurrencyType currencyType
- The currency in which the fee amount is given.
feeAmount
String feeAmount
- The amount of fees. The amount is given in currency
specified by the currency type field.
feeType
FeeType feeType
- The type of the fee.
currentLocation
String currentLocation
- The current location of the item.
expirationDate
String expirationDate
- The expiration date of the hold.
pickupLocation
String pickupLocation
- The pickup location of the hold.
bibId
String bibId
- Bibliographic id of the record. This is a Voyager ESIP extension.
terminalPassword
String terminalPassword
- Password for the system to login to the ILS. If this feature is not
used by the ILS in the library then the value should be empty if it's
required in the request, and can be omitted entirely if the field is
optional in the message.
patronPassword
String patronPassword
- Password (PIN) of the patron. If this feature is not used by the
ILS in the library then the value should be empty if it's required
in the request, and can be omitted entirely if the field is optional
in the message.
feeAcknowledged
boolean feeAcknowledged
- If false and there's a fee associated with the transaction,
the ILS SIP server should tell the system in the response that
there's a fee, and refuse to complete the transaction. If the system and the
patron then interact and the patron agrees to pay the fee, this field
will be set to true on a second request message, indicatin to the ILS
SIP server that the patron has acknowledged the fee and the transaction
should not be refused just because there is a fee associated with it.
useFeeAcknowledged
boolean useFeeAcknowledged
- Tells if fee acknowledged field show be added to the request.
ok
boolean ok
- Tells that the requested action was allowable and completed succesfully.
data
String data
- Message data received from the ILS SIP server
screenMessage
List<E> screenMessage
- Variable-length field. This field provides a way for the ILS to display
messages on the system's screen. They are never required. When used,
there can be one or more of those fields, which are then displayed on
consecutive lines of the screen.
printLine
List<E> printLine
- Variable-length field. This field provides a way for the ILS to print
messages on the system's printer. They are never required. When used,
there can be one or more of these fields, which are then pronted on
consecutive lines of the printer.
dueDate
String dueDate
- Due date for the item. The ILS can send this information in any format
it wishes.
permanentLocation
String permanentLocation
- The location where the item is normally stored.
mediaType
MediaType mediaType
- Media type of the item.
|
Package com.pkrete.jsip2.messages.requests |
cardRetained
boolean cardRetained
- Indicates that the patron'n library card has been retained by
the system. The ILS may ignore this field or notify the library staff
that the patron's card has been retained by the system.
blockedCardMsg
String blockedCardMsg
- The reason why the patron's card was blocked.
returnDate
String returnDate
- The date that an item was returned to the library, that is not
necessarily the same date when the item was checked back in. 18-char,
fixed-length field: YYYYMMDDZZZZHHMMSS.
scRenewalPolicy
boolean scRenewalPolicy
- Tells if the system has been configured to do renewals by the library
staff. False means that the system has been configured not to do
renewals.
noBlock
boolean noBlock
- Notifies the ILS SIP server that the item was already checked in or out
while while the SIP server wasn't on-line. When true the SIP server
should not block the transaction, because it has already been executed.
The system can perform transactions while the SIP server is off-line.
These transactions are stored and will be sent to the SIP server when
it comes back on-line.
cancel
boolean cancel
- Should be set to true for a checkout command being used to cancel a
failed checkin command, or for a checkin command being used to cancel
a failed chakout command. Should be set to false for all other checkout
or checkin commands. Optional field.
useCancel
boolean useCancel
- Tells if cancel field show be added to the request, as the
field is optional.
nbDueDate
String nbDueDate
- No block due date items were given during off-line operation.
18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
paymentType
PaymentType paymentType
- The type of the payment: cash, VISA or credit card.
feeIdentifier
String feeIdentifier
- Identifies a specific fee, possible together with fee type.
This identifier would have to be user-selected from a list of fees.
holdMode
HoldMode holdMode
- The type of the hold transaction: add, delete or modify. The
default is add.
holdType
HoldType holdType
- The type of the hold: other, any copy, specific copy
or any copy at a single branch or sublocation.
UIDAlgorithm
char UIDAlgorithm
- Specifies the algorith used to encrypt userName
PWDAlgorithm
char PWDAlgorithm
- Specifies the algorith used to encrypt password
userName
String userName
- Username to login to the ILS
password
String password
- Password to login to the ILS
circulationLocation
String circulationLocation
- ILS's circulation location to be used
summary
Summary summary
- Defines what detailed and summary information of selected category of
items that are be requested as a part of this request. For example a list
of items that the patron has borrowed.
startItem
String startItem
- Specifies the number of the first item to be sent in the list defined
by the summary. Optional field.
endItem
String endItem
- Specifies the number of the last item to be sent in the list defined
by the summary. Optional field.
language
Language language
- Language requested by the patron.
thirdPartyAllowed
boolean thirdPartyAllowed
- If this value is false then ILS should not allow third party renewals.
This allows the library staff to prevent third part renewals from
this terminal.
statusCode
StatusCode statusCode
- Status of the system
maxPrintWidth
String maxPrintWidth
- Number of characters the system printer can print on one line
protocolVersion
String protocolVersion
- Version of the SIP protocol that's used: 2.00
|
Package com.pkrete.jsip2.messages.responses |
onLineStatus
boolean onLineStatus
- Is the ILS SIP server online.
checkinOk
boolean checkinOk
- Is the system allowed to checkin items.
checkoutOk
boolean checkoutOk
- Is the system allowe to checkout items.
ILSRenewalPolicy
boolean ILSRenewalPolicy
- Is the system allowed to process patron renewal requests.
statusUpdateOk
boolean statusUpdateOk
- Is the system allowed to update patron status, e.g., a patron's
card status can be changed to blocked
offlineOk
boolean offlineOk
- Does the ILS SIP server support off-line operation feature.
timeoutPeriod
int timeoutPeriod
- This timeout period until a transaction is
aborted should be a number expressed in tenths of a second. 000 indicates
that the ILS is not online. 999 indicates that the time-out is unknown.
retriesAllowed
int retriesAllowed
- The number of retries that are allowed for a specific transaction.
999 indicates that the retry number is unknown.
dateTimeSync
String dateTimeSync
- 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS. May be used to
synchronize clocks.
protocolVersion
String protocolVersion
- 4-char, fixed-length field: x.xx. The protocol version that the
ILS SIP server is currently using.
libraryName
String libraryName
- Variable-length field. The library's name.
supportedMessages
SupportedMessages supportedMessages
- This variable holds the information about which messages the
ILS supports.
terminalLocation
String terminalLocation
- Variable-length field. The ILS could put the system's location in this
field.
resensitize
boolean resensitize
- Tells if the item should be resensitized.
alert
boolean alert
- Tells if there's an alert related to the item or the the patron.
The alert indicates conditions like items on hold, items belonging to
another library branch, or other alert conditions as determined by
the ILS.
sortBin
String sortBin
- A bin number that indicates how the item should be sorted.
Optional field.
collectionCode
String collectionCode
- The item collection code. Collection codes represent a set of item within
library or a location for a group of item. One use of this field is in
sortation systems for high level sorting of materials.
callNumber
String callNumber
- Code which indicates the item's permanent physical location.
This is an extension field and it's not included in the original SIP2
definition.
destinationLocation
String destinationLocation
- The description or identifier for the location where the item should go
next. This is an extension field and it's not included in the original SIP2
definition.
alertType
AlertType alertType
- The type of the alert. This is an extension field and it's not included
in the original SIP2 definition.
holdPatronId
String holdPatronId
- The patron id of the patron assigned to the hold for the item.
This is an extension field and it's not included in the original SIP2
definition.
holdPatronName
String holdPatronName
- The patron name of the patron assigned to the hold for the item.
This is an extension field and it's not included in the original SIP2
definition.
renewalOk
boolean renewalOk
- Tells if the item is already checked out. True means that the item was
already checked out to the same patron, so the item is actually being
renewed. False means that the patron did not already have the item
checked out.
desensitizeSupported
boolean desensitizeSupported
- Tells if the ILS recognizes if the item should or should not be
desensitized. If this value is false, then also desensitize must
be false.
desensitize
boolean desensitize
- Tells if the system should desensitize the item. If the ILS does not
know if the item should be desensitized or not, then this value must
be false.
securityInhibit
boolean securityInhibit
- Tells if the system should ignore the security status of the item.
Optional field.
securityInhibitUsed
boolean securityInhibitUsed
- Indicates if the securityInhibit value was used in the response
received from the ILS SIP server.
magneticMediaSupported
boolean magneticMediaSupported
- Tells if the ILS identifies magnetic media items. If this value is false,
then also magneticMedia is false.
magneticMedia
boolean magneticMedia
- Tells if the item is magnetic media and the system will then handle
the security discharge accordingly. This value should be used if and
only if the ILS identifies magnetic media items, which means that
magneticMediaSupported should be true.
endSession
boolean endSession
- Tells if the ILS has ended the patron's session. False means
an error condition.
paymentAccepted
boolean paymentAccepted
- True indicates that the ILS has accepted the payment from the patron
and the patron's account will be adjusted accordingly.
available
boolean available
- True means that the item is available, it's not checked out or on hold.
queuePosition
String queuePosition
- A numeric value for the patron's position in the hold queue for an item.
isbn
String isbn
- ISBN number of the record that was put on hold.
This is a Voyager ESIP extension.
lccn
String lccn
- LCCN number of the record that was put on hold. This is a Voyager
ESIP extension.
circulationStatus
CirculationStatus circulationStatus
- The circulation status of the item.
securityMarker
SecurityMarker securityMarker
- The security marker of the item.
holdQueueLength
String holdQueueLength
- Number of patrons requesting this item. Optional field.
owner
String owner
- The name of the institution or library that owns the item.
Optional field.
recallDate
String recallDate
- The date that the recall was issued. 18-char, fixed-length
field: YYYYMMDDZZZZHHMMSS. Optional field.
holdPickupDate
String holdPickupDate
- The date that the hold expires. 18-char, fixed-length
field: YYYYMMDDZZZZHHMMSS. Optional field.
itemPropertiesOk
boolean itemPropertiesOk
- True means that the item properties have been stored on the ILS
database. False means that the properties were not stored.
feeLimit
String feeLimit
- The limiting value for fines and fees that the patron is allowed
to accumulate in his account. It's a money amount in whatever
currency type is defined in this message. This value is optional.
holdItemsCount
int holdItemsCount
- Number of items on hold.
overdueItemsCount
int overdueItemsCount
- Number of overdue items.
chargedItemsCount
int chargedItemsCount
- Number of charged items.
fineItemsCount
int fineItemsCount
- Number of fine items.
recallItemsCount
int recallItemsCount
- Number of recall items.
unavailableHoldsCount
int unavailableHoldsCount
- Unavailable holds count.
holdItemsLimit
int holdItemsLimit
- Limit number for hold items for this patron.
overdueItemsLimit
int overdueItemsLimit
- Limit number for overdue items for this patron.
chargedItemsLimit
int chargedItemsLimit
- Limit number for charged items for this patron.
homeAddress
String homeAddress
- Home address.
email
String email
- Email address.
phone
String phone
- Phone number.
birthDate
String birthDate
- Birth date of the patron. 8-char, fixed length optional field: YYYYMMDD.
This is an extension field and it's not included in the original SIP2
definition.
pacAccessType
String pacAccessType
- Identifies patron's PAC access level. This is an extension field and
it's not included in the original SIP2 definition.
patronType
String patronType
- Patron type, such as child, juvenile, adult, etc. This is an extension
field and it's not included in the original SIP2 definition.
patronGroup
String patronGroup
- Patron group code. This is a Voyager ESIP extension.
items
List<E> items
- Zero or more item barcodes of the item type defined in the summary field
of the PatronInformationRequest message.
itemType
ItemType itemType
- Type of the items in the items list.
status
PatronStatus status
- Patron's status.
language
Language language
- Language.
personalName
String personalName
- Patron's name.
validPatron
boolean validPatron
- Indicates if the patron barcode is valid. Optional field.
validPatronUsed
boolean validPatronUsed
- Indicates if the validPatron value was used in the response
received from the ILS SIP server.
validPatronPassword
boolean validPatronPassword
- Indicates if the patron password is valid. Optional field.
validPatronPasswordUsed
boolean validPatronPasswordUsed
- Indicates if the validPatronPassword value was used in the response
received from the ILS SIP server.
renewedCount
int renewedCount
- A count of the number of items that were renewed.
unrenewedCount
int unrenewedCount
- A count of the number of items that were not renewed.
renewedItems
List<E> renewedItems
- List of renewed items.
unrenewedItems
List<E> unrenewedItems
- List of unrenewd items.
Copyright © 2012-2014. All Rights Reserved.