A B C D E F G H I L M N O P R S T U V W

A

AlertType - Enum in com.pkrete.jsip2.variables
This enum defines a set of alert types that can be used in SIP2 response messages to describe the type of the alert for a specific item.
AlertTypeFactory - Class in com.pkrete.jsip2.variables
This class generates AlertType objects based on the alert code.

B

bibId - Variable in class com.pkrete.jsip2.messages.SIP2Message
Bibliographic id of the record.
bool2Char(boolean) - Static method in class com.pkrete.jsip2.util.StringUtil
Converts the given boolean to character. false = N, true = Y.
bool2CharEmpty(boolean) - Static method in class com.pkrete.jsip2.util.StringUtil
Converts the given boolean to character. false = ' ', true = 'Y'.
bool2Int(boolean) - Static method in class com.pkrete.jsip2.util.StringUtil
Converts the given boolean to string. false = 0, true = 1.

C

cancel - Variable in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
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.
charEmptyToBool(char) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Converts the given character to a boolean value.
charToBool(char) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Converts the given character to a boolean value.
checkSum - Variable in class com.pkrete.jsip2.messages.SIP2Message
Checksum is four ASCII charater digits representing the binary sum of the characters included the message
CirculationStatus - Enum in com.pkrete.jsip2.variables
This enum defines a set of circulation statuses that can be used in SIP2 request and response messages.
CirculationStatusFactory - Class in com.pkrete.jsip2.variables
This class generates CirculationStatus objects based on the circulation status code.
close() - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Closes the connection to the ILS SIP server.
code - Variable in class com.pkrete.jsip2.messages.SIP2Message
Command identifier
com.pkrete.jsip2.connection - package com.pkrete.jsip2.connection
 
com.pkrete.jsip2.exceptions - package com.pkrete.jsip2.exceptions
 
com.pkrete.jsip2.messages - package com.pkrete.jsip2.messages
 
com.pkrete.jsip2.messages.requests - package com.pkrete.jsip2.messages.requests
 
com.pkrete.jsip2.messages.responses - package com.pkrete.jsip2.messages.responses
 
com.pkrete.jsip2.parser - package com.pkrete.jsip2.parser
 
com.pkrete.jsip2.util - package com.pkrete.jsip2.util
 
com.pkrete.jsip2.variables - package com.pkrete.jsip2.variables
 
computeChecksum(String) - Static method in class com.pkrete.jsip2.util.MessageUtil
Computes the checksum of the given string.
connect() - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Connects to the ILS SIP server.
connected() - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Returns true if and only if the socket is connected to a server.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2EndSessionResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2FeePaidResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemStatusUpdateResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2LoginResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronEnableResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronStatusResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Counts the chekcsum of this response message.
countChecksum() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns the checksum of the message.
counter - Static variable in class com.pkrete.jsip2.messages.SIP2MessageRequest
Number of messages that the system has sent.
create(String) - Method in class com.pkrete.jsip2.messages.SIP2ResponseFactory
Creates a new SIP2MessageResponse object based on the given data.
createFutureDate(int, int) - Static method in class com.pkrete.jsip2.util.MessageUtil
Creates a new date/time string presented in the SIP2 format "yyyyMMdd HHmmss" by adding the given number of days and months to the current date.
currencyType - Variable in class com.pkrete.jsip2.messages.SIP2Message
The currency in which the fee amount is given.
CurrencyType - Enum in com.pkrete.jsip2.variables
This enum defines a set of currency types that can be used in SIP2 request and response messages.
CurrencyTypeFactory - Class in com.pkrete.jsip2.variables
This class generates CurrencyType objects based on the currency code.
currentLocation - Variable in class com.pkrete.jsip2.messages.SIP2Message
The current location of the item.

D

data - Variable in class com.pkrete.jsip2.messages.SIP2MessageResponse
Message data received from the ILS SIP server
desensitize - Variable in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Tells if the system should desensitize the item.
desensitizeSupported - Variable in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Tells if the ILS recognizes if the item should or should not be desensitized.
dueDate - Variable in class com.pkrete.jsip2.messages.SIP2MessageResponse
Due date for the item.

E

errorDetectionEnabled - Static variable in class com.pkrete.jsip2.messages.SIP2MessageRequest
When error detection is enabled, a sequence number field, followed by a checksum number field, is appended to every message.
exists(String, String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Returns true if and only if the given variable is present in the given string.
existsAndNotEmpty(String, String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Returns true if and only if the given variable and a value are present in the given string.
expirationDate - Variable in class com.pkrete.jsip2.messages.SIP2Message
The expiration date of the hold.

F

feeAcknowledged - Variable in class com.pkrete.jsip2.messages.SIP2MessageRequest
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.
feeAmount - Variable in class com.pkrete.jsip2.messages.SIP2Message
The amount of fees.
feeType - Variable in class com.pkrete.jsip2.messages.SIP2Message
The type of the fee.
FeeType - Enum in com.pkrete.jsip2.variables
This enum defines a set of fee types that can be used in SIP2 response messages to describe the type of the fee related to a transaction or to a patron.
FeeTypeFactory - Class in com.pkrete.jsip2.variables
This class generates FeeType objects based on the fee code.

G

getAlertType() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Return the type of the alert.
getAlertType(String) - Method in class com.pkrete.jsip2.variables.AlertTypeFactory
Returns the alert type that matches the given code.
getAllItemTypes() - Method in class com.pkrete.jsip2.variables.ItemTypeFactory
Returns a list that contains all the item types.
getBibId() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the bibliographic id of a record.
getBirthDate() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the patron's birth date. 6-char, fixed-length field, MMDDYYYY.
getBlockedCardMsg() - Method in class com.pkrete.jsip2.messages.requests.SIP2BlockPatronRequest
Returns the reason why the patron's card was blocked.
getCallNumber() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns the code which indicates the item's permanent physical location.
getChargedItemsCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the number of charged items for this patron.
getChargedItemsLimit() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the limit number for charged items for this patron.
getCheckSum() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the checksum representing the binary sum of the characters included the message.
getCheckSum() - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Returns the checksum representing the binary sum of the characters included the message.
getCirculationLocation() - Method in class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Returns the ILS's circulation location to be used.
getCirculationStatus() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Returns the circulation status of the item.
getCirculationStatus(String) - Method in class com.pkrete.jsip2.variables.CirculationStatusFactory
Returns a circulation status matching the given circulation status code.
getCode() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the command identifier of this message.
getCollectionCode() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns the item collection code.
getCurrencyType() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the currency type of fees.
getCurrencyType(String) - Method in class com.pkrete.jsip2.variables.CurrencyTypeFactory
Returns the currency type that matches the given code.
getCurrentLocation() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the current location of the item.
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2BlockPatronRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2CheckinRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2EndPatronSessionRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2FeePaidRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2ItemInformationRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2ItemStatusUpdateRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronEnableRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronStatusRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2RenewAllRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2RenewRequest
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2RequestResend
 
getData() - Method in class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
 
getData() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns a string presentation of the message.
getData() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns the message data received from the ILS SIP server.
getDateTimeSync() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns the date and time received from the ILS SIP server. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
getDestinationLocation() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns the description or identifier for the location where the item should go next.
getDueDate() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns the due date for this item.
getEmail() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the email address of the patron.
getEndItem() - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Returns the number of the last item to be sent in the list defined by the summary.
getExpirationDate() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the expiration date of the hold. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
getFeeAmount() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the amount of fees.
getFeeIdentifier() - Method in class com.pkrete.jsip2.messages.requests.SIP2FeePaidRequest
Returns a value that identifies a specific fee, possible together with fee type.
getFeeLimit() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the limiting value for fines and fees that the patron is allowed to accumulate in his account.
getFeeType() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the fee type.
getFeeType(String) - Method in class com.pkrete.jsip2.variables.FeeTypeFactory
Returns the fee type that matches the given code.
getFineItemsCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the number of fine items for this patron.
getHoldItemsCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the number of hold items for this patron.
getHoldItemsLimit() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the limit number for hold items for this patron.
getHoldMode() - Method in class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Returns the type of the hold transaction: create, delete or modify.
getHoldPatronId() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns the patron id of the patron assigned to the hold for the item.
getHoldPatronName() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns the patron name of the patron assigned to the hold for the item.
getHoldPickupDate() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Returns the date that the hold expires. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
getHoldQueueLength() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Returns the number of patrons requesting this item.
getHoldType() - Method in class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Returns the type of the hold: other, any copy, specific copy or any copy at a single branch or sublocation.
getHomeAddress() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the home address of the patron.
getInstance() - Static method in class com.pkrete.jsip2.messages.SIP2ResponseFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.AlertTypeFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.CirculationStatusFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.CurrencyTypeFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.FeeTypeFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.ItemTypeFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.LanguageFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.MediaTypeFactory
Returns a reference to the singleton object.
getInstance() - Static method in class com.pkrete.jsip2.variables.SecurityMarkerFactory
Returns a reference to the singleton object.
getInstitutionId() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the library's id.
getIsbn() - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Returns the ISBN number of the record that was put on hold.
getItemIdentifier() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the item identifier.
getItemProperties() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns a specific item information that can be used for identifying an item, such as item weight, size, security marker, etc.
getItems() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns a list of item barcodes of the item type defined in the PatronInformationRequest message.
getItemType() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the type of the items in the items list.
getItemType(String) - Method in class com.pkrete.jsip2.variables.ItemTypeFactory
Returns the item type that matches the given code.
getLanguage() - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronRequest
Returns the language requested by the patron.
getLanguage() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Returns the language
getLanguage(String) - Method in class com.pkrete.jsip2.variables.LanguageFactory
Returns a language matching the given language code.
getLccn() - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Returns the LCCN number of the record that was put on hold.
getLibraryName() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns the library's name.
getMaxPrintWidth() - Method in class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
Returns the maximum number of characters that the system printer can print in one line.
getMediaType() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns the media type of the item.
getMediaType(String) - Method in class com.pkrete.jsip2.variables.MediaTypeFactory
Returns the media type that matches the given code.
getNbDueDate() - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Returns the no block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS
getOverdueItemsCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the number of overdue items for this patron.
getOverdueItemsLimit() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the limit number for overdue items for this patron.
getOwner() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Returns the name of the institution or library that owns the item.
getPacAccessType() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the patron's PAC access level.
getPassword() - Method in class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Returns the password to login to the ILS.
getPatronGroup() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the code of the patron group in which the patron belongs to.
getPatronIdentifier() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the patron identifier, library card's barcode number for example.
getPatronPassword() - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Returns the password (PIN) of the patron.
getPatronType() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the patron's patron type, such as child, juvenile, adult, etc
getPaymentType() - Method in class com.pkrete.jsip2.messages.requests.SIP2FeePaidRequest
Returns the type of the payment: cash, VISA or credit card.
getPermanentLocation() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns the location where the item is normally stored.
getPersonalName() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Returns the patron name.
getPhone() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the phnoe number of the patron.
getPickupLocation() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the pickup location of the hold.
getPrintLine() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns a list of messages received from the ILS to print on the system's printer.
getProtocolVersion() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns the protocol version that the ILS SIP server is currently using. 4-char, fixed-length field: x.xx.
getQueuePosition() - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Returns a numeric value for the patron's position in the hold queue for an item.
getRecallDate() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Returns the date that the recall was issued. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
getRecallItemsCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Returns the number of recall items for this patron.
getRenewedCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Returns the count of the number of items that were renewed.
getRenewedItems() - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Returns a list of items that were renewed.
getRetriesAllowed() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns the number of retries that are allowed for a specific transaction.
getReturnDate() - Method in class com.pkrete.jsip2.messages.requests.SIP2CheckinRequest
Returns 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.
getScreenMessage() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns a list of messages received from the ILS to display on the system's screen.
getSecurityMarker() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Returns the security marker of the item.
getSecurityMarker(String) - Method in class com.pkrete.jsip2.variables.SecurityMarkerFactory
Returns the security marker that matches the given code.
getSequence() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the sequence nnumber of the message that is between 0 and 9.
getSipDateTime() - Static method in class com.pkrete.jsip2.util.MessageUtil
Returns the current date and time in the format used in the SIP2 messages.
getSocket() - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Returns the socket used for the connection with the ILS SIP server.
getSortBin() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns the bin number that indicates how the item should be sorted.
getStartItem() - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Returns the number of the first item to be sent in the list defined by the summary.
getStatus() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Returns a PatronStatus object that contains all the information about the patron's status.
getStatusCode() - Method in class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
Returns the status of the system.
getSummary() - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Returns what detailed and summary information of selected category of items that are be requested as a part of this request.
getSupportedMessages() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns the informations about the supported messages by the ILS SIP server.
getTerminalLocation() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns the system's location received from the ILS.
getTerminalPassword() - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Returns the password for the system to login to the ILS.
getTimeoutPeriod() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns a timeout period until a transaction is aborted.
getTitleIdentifier() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns an identifying value for the title.
getTransactionDate() - Method in class com.pkrete.jsip2.messages.SIP2Message
Return the transaction date in the SIP2 format: 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
getTransactionId() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns the transaction id that is assigned by the ILS or by a payment device, for auditing purposes to track cash flow.
getUnavailableHoldsCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Return the number of unavailable holds for this patron.
getUnrenewedCount() - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Returns the count of the number of items that were not renewed.
getUnrenewedItems() - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Returns a list of items that were not renewed.
getUserName() - Method in class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Returns the username to login to the ILS.

H

HoldMode - Enum in com.pkrete.jsip2.variables
This enum defines a set of hold modes that are used in SIP2 SIP2HoldRequest messages to describe the type of the hold transaction.
HoldType - Enum in com.pkrete.jsip2.variables
This enum defines a set of hold types that are used in SIP2 SIP2HoldRequest messages to describe the type of the hold.

I

institutionId - Variable in class com.pkrete.jsip2.messages.SIP2Message
Library's institution id.
intToBool(char) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Converts the given character to a boolean value.
intToFixedLengthString(int, int) - Static method in class com.pkrete.jsip2.util.StringUtil
Converts the given integer to a fixed length string by adding leading zeros to the given number that its length equals to the given length.
InvalidSIP2ResponseException - Exception in com.pkrete.jsip2.exceptions
This class extends the Exception class and it represents an exception that occurs when parsing data related to a SIP2ResponseMessage object.
InvalidSIP2ResponseException(String) - Constructor for exception com.pkrete.jsip2.exceptions.InvalidSIP2ResponseException
Constructs and initializes a new InvalidSIP2ResponseException object with the given error message.
InvalidSIP2ResponseValueException - Exception in com.pkrete.jsip2.exceptions
This class extends the Exception class and it represents an exception that occurs when parsing data of the variables of a SIP2ResponseMessage object.
InvalidSIP2ResponseValueException(String) - Constructor for exception com.pkrete.jsip2.exceptions.InvalidSIP2ResponseValueException
Constructs and initializes a new InvalidSIP2ResponseValueException object with the given error message.
isAlert() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns true if and only if there's an alert related to the item or the the patron.
isAvailable() - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Returns true if and only if the item is available, it's not checked out or on hold.
isBlockPatron() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is block patron request/response message pair supported.
isCancel() - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Returns true if and only if the checkout command is used to cancel a failed checkin command.
isCardReportedLost() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron's card is reported lost.
isCardRetained() - Method in class com.pkrete.jsip2.messages.requests.SIP2BlockPatronRequest
Returns true if and only if the patron'n library card has been retained by the system.
isChargedItems() - Method in class com.pkrete.jsip2.variables.Summary
Returns true if and only if detailed as well as summary information about the charged items category can be sent in the response.
isChargePrivilegesDenied() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron's charge privileges are denied.
isCheckin() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is checkin request/response message pair supported.
isCheckinOk() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns true if, and only if, the system is allowed to checkin items.
isCheckout() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is checkout request/response message pair supported.
isCheckoutOk() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns true if, and only if, the system is allowed to checkout items.
isChecksum() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns true, if and only if, the checksum variable is present in the message.
isDesensitize() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Returns true if and only if the system should desensitize the item.
isDesensitizeSupported() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Returns true if and only if the ILS recognizes that the item should or should not be desensitized.
isEndPatronSession() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is end patron session request/response message pair supported.
isEndSession() - Method in class com.pkrete.jsip2.messages.responses.SIP2EndSessionResponse
Returns true if and only if the ILS has ended the patron's session.
isErrorDetectionEnabled() - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Returns true if and only if the error detection is enabled.
isExcessiveOutstandingFees() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has excessive outstanding fees.
isExcessiveOutstandingFines() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has excessive outstanding fines.
isFeeAcknowledged() - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Returns true if and only if there's a fee associated with the transaction and the patron has agreed to pay the fee.
isFeePaid() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is fee paid request/response message pair supported.
isFineItems() - Method in class com.pkrete.jsip2.variables.Summary
Returns true if and only if detailed as well as summary information about the fine items category can be sent in the response.
isHold() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is hold request/response message pair supported.
isHoldItems() - Method in class com.pkrete.jsip2.variables.Summary
Returns true if and only if detailed as well as summary information about the hold items category can be sent in the response.
isHoldPrivilegesDenied() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron's hold privileges are denied.
isILSRenewalPolicy() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns true if, and only if, the system is allowed to process patrons renewal requests.
isItemInformation() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is item information request/response message pair supported.
isItemPropertiesOk() - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemStatusUpdateResponse
Returns true if and only if the item properties have been stored on the ILS database.
isItemStatusUpdate() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is item status update request/response message pair supported.
isLogin() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is login request/response message pair supported.
isMagneticMedia() - Method in class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
Returns true if and only if the item is magnetic media and the ILS identifies magnetic media.
isMagneticMediaSupported() - Method in class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
Returns true if and only if the ILS identifies magnetic media items.
isNoBlock() - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Returns true if and only if the transaction happened when the ILS SIP server was off-line.
isOfflineOk() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns true if, and only if, the ILS SIP server supports off-line operation feature.
isOk() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns true if and only if the requested action was allowable and completed succesfully.
isOnLineStatus() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns true if, and only if, the ILS SIP server is online.
isOverdueItems() - Method in class com.pkrete.jsip2.variables.Summary
Returns true if and only if detailed as well as summary information about the overdue items category can be sent in the response.
isPatronEnable() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is request/response message pair supported.
isPatronInformation() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is patron information request/response message pair supported.
isPatronStatusRequest() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is patron status request message supported.
isPaymentAccepted() - Method in class com.pkrete.jsip2.messages.responses.SIP2FeePaidResponse
Returns true if and only if the ILS has accepted the payment from the patron.
isRecallItems() - Method in class com.pkrete.jsip2.variables.Summary
Returns true if and only if detailed as well as summary information about the recall items category can be sent in the response.
isRecallOverdue() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has overdue recall.
isRecallPrivilegesDenied() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron's recall privileges are denied.
isRenew() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is renew request/response message pair supported.
isRenewAll() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is renew all request/response message pair supported.
isRenewalOk() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Returns true if and only if the item is already checked out.
isRenewalPrivilegesDenied() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron's renewal privileges are denied.
isRequestSCILSResend() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is request SC/ILS resend request/response message pair is supported.
isResensitize() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Returns true if and only if the item should be resensitized.
isSCILSStatus() - Method in class com.pkrete.jsip2.variables.SupportedMessages
Is SC/ILS status request/response message pair supported.
isScRenewalPolicy() - Method in class com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest
Returns true if and only if the system has been configured to do renewals, otherwise return false.
isSecurityInhibit() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Returns true if and only if the system should ignore the security status of the item.
isSecurityInhibitUsed() - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Returns true if and only if the securityInhibit field was used in the response message received from the ILS SIP server.
isSequence() - Method in class com.pkrete.jsip2.messages.SIP2Message
Returns true, if and only if, the sequence variable is present in the message.
isStatusUpdateOk() - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Returns true if, and only if, the system is allowed to update patron status.
isThirdPartyAllowed() - Method in class com.pkrete.jsip2.messages.requests.SIP2RenewRequest
Returns true if and only if third party renewals are allowed.
isTooManyClaimsOfItemsReturned() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has too many claims of items returned.
isTooManyItemsBilled() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has too many billed items.
isTooManyItemsCharged() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has too many items charged.
isTooManyItemsLost() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has too many lost items.
isTooManyItemsOverdue() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has too many overdue items.
isTooManyRenewals() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns true if and only if the patron has too many renewals.
isUnavailableHolds() - Method in class com.pkrete.jsip2.variables.Summary
Returns true if and only if detailed as well as summary information about the unavailable holds category can be sent in the response.
isUseCancel() - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Returns true if and only if the cancel field should be added to the request.
isUseFeeAcknowledged() - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Returns true if and only if the fee acknowledged should be added to the request.
isValid() - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Returns true, if and only if, the response message is valid.
isValidPatron() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Return true if and only if the patron barcode is valid, otherwise returns false.
isValidPatronPassword() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Return true if and only if the patron password is valid, otherwise returns false.
isValidPatronPasswordUsed() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Returns true if and only if the valid patron password field was used in the response message received from the ILS SIP server.
isValidPatronUsed() - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Returns true if and only if the valid patron field was used in the response message received from the ILS SIP server.
itemIdentifier - Variable in class com.pkrete.jsip2.messages.SIP2Message
Identifying value for the item.
itemProperties - Variable in class com.pkrete.jsip2.messages.SIP2Message
Specific item information that can be used for identifying an item, such as item weight, size, security marker, etc.
ItemType - Enum in com.pkrete.jsip2.variables
This enum defines a set of item types that can be used in SIP2 patron information response message to describe the type of the items listed in the summary field.
ItemTypeFactory - Class in com.pkrete.jsip2.variables
This class generates ItemType objects based on the item code.

L

language - Variable in class com.pkrete.jsip2.messages.requests.SIP2PatronRequest
Language requested by the patron.
language - Variable in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Language.
Language - Enum in com.pkrete.jsip2.variables
This enum defines a set of languages that can be used in SIP2 request and response messages.
LanguageFactory - Class in com.pkrete.jsip2.variables
This class generates Language objects based on the language code.

M

magneticMedia - Variable in class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
Tells if the item is magnetic media and the system will then handle the security discharge accordingly.
magneticMediaSupported - Variable in class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
Tells if the ILS identifies magnetic media items.
mediaType - Variable in class com.pkrete.jsip2.messages.SIP2MessageResponse
Media type of the item.
MediaType - Enum in com.pkrete.jsip2.variables
This enum defines a set of media types that can be used in SIP2 response messages to describe the media type of an item.
MediaTypeFactory - Class in com.pkrete.jsip2.variables
This class generates MediaType objects based on the media code.
MessageUtil - Class in com.pkrete.jsip2.util
This class offers methods that are needed for creating SIP2 messages.
MessageUtil() - Constructor for class com.pkrete.jsip2.util.MessageUtil
 

N

nbDueDate - Variable in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
No block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
noBlock - Variable in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Notifies the ILS SIP server that the item was already checked in or out while while the SIP server wasn't on-line.

O

ok - Variable in class com.pkrete.jsip2.messages.SIP2MessageResponse
Tells that the requested action was allowable and completed succesfully.

P

parse(String) - Method in class com.pkrete.jsip2.parser.SIP2ACSStatusResponseParser
Parses a new SIP2ACSStatusResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2CheckinResponseParser
Parses a new SIP2CheckinResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2CheckoutResponseParser
Parses a new SIP2CheckoutResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2EndSessionResponseParser
Parses a new SIP2EndSessionResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2FeePaidResponseParser
Parses a new SIP2FeePaidResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2HoldResponseParser
Parses a new SIP2HoldResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2ItemInformationResponseParser
Parses a new SIP2ItemInformationResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2ItemStatusUpdateResponseParser
Parses a new SIP2ItemStatusUpdateResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2LoginResponseParser
Parses a new SIP2LoginResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2PatronEnableResponseParser
Parses a new SIP2PatronEnableResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2PatronInformationResponseParser
Parses a new SIP2PatronInformationResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2PatronStatusResponseParser
Parses a new SIP2PatronStatusResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2RenewAllResponseParser
Parses a new SIP2RenewAllResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2RenewResponseParser
Parses a new SIP2RenewResponse from the given data.
parse(String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses a SIP2MessageResponse from the given string.
parseChecksum(String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses the checksum from the given string.
parseSequence(String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses the sequence from the given string.
parseSipDateTime(String) - Static method in class com.pkrete.jsip2.util.MessageUtil
Parses the date and time from the given SIP2 formatted string.
parseVariable(String, String, boolean) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses the value of the given variable from the given data string.
parseVariable(String, String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses the value of the given variable from the given data string.
parseVariableMulti(String, String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses the value of the given variable from the given data string.
parseVariableWithoutDelimiter(String, String, boolean) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses the value of the given variable from the given data string.
parseVariableWithoutDelimiter(String, String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Parses the value of the given variable from the given data string.
patronIdentifier - Variable in class com.pkrete.jsip2.messages.SIP2Message
An identifying value for the patron, library card's barcode number for example.
patronPassword - Variable in class com.pkrete.jsip2.messages.SIP2MessageRequest
Password (PIN) of the patron.
PatronStatus - Class in com.pkrete.jsip2.variables
This class represents the patron status information that is received as a part of the SIP2PatronStatusResponse response message.
PatronStatus() - Constructor for class com.pkrete.jsip2.variables.PatronStatus
Constructs and initializes a new PatronStatus object with all the variables set to false.
PaymentType - Enum in com.pkrete.jsip2.variables
This enum defines a set of payment types that are used in SIP2 SIP2FeePaidRequest messages to describe the type of the payment.
permanentLocation - Variable in class com.pkrete.jsip2.messages.SIP2MessageResponse
The location where the item is normally stored.
personalName - Variable in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Patron's name.
pickupLocation - Variable in class com.pkrete.jsip2.messages.SIP2Message
The pickup location of the hold.
printLine - Variable in class com.pkrete.jsip2.messages.SIP2MessageResponse
Variable-length field.

R

read() - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Read a line of text.
renewalOk - Variable in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Tells if the item is already checked out.

S

screenMessage - Variable in class com.pkrete.jsip2.messages.SIP2MessageResponse
Variable-length field.
securityInhibit - Variable in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Tells if the system should ignore the security status of the item.
securityInhibitUsed - Variable in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Indicates if the securityInhibit value was used in the response received from the ILS SIP server.
SecurityMarker - Enum in com.pkrete.jsip2.variables
This enum defines a set of security markers that can be used in SIP2 item information response message to describe the security marker type of the items.
SecurityMarkerFactory - Class in com.pkrete.jsip2.variables
This class generates SecurityMarker objects based on the security marker code.
send(SIP2MessageRequest) - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Sends the given SIP2MessageRequest to the ILS SIP server and returns the SIP2MessageResponse received.
sequence - Variable in class com.pkrete.jsip2.messages.SIP2Message
Sequence number of the message (0-9)
setAlert(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the value that tells if there's an alert related to the item or the the patron.
setAlertType(AlertType) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the type of the alert.
setAvailable(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Sets the value that tells the item is available.
setBibId(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the bibliographic id of a record.
setBirthDate(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Sets the patron's birth date.
setBlockedCardMsg(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2BlockPatronRequest
Sets the reason why the patron's card was blocked,
setBlockPatron(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if block patron request/response message pair is supported.
setCallNumber(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the code which indicates the item's permanent physical location.
setCancel(boolean) - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Sets the value that tells if the checkout command is used to cancel a failed checkin command.
setCardReportedLost(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron's card is reported lost.
setCardRetained(boolean) - Method in class com.pkrete.jsip2.messages.requests.SIP2BlockPatronRequest
Sets the value that tells if the patron'n library card has been retained by the system.
setChargedItems(boolean) - Method in class com.pkrete.jsip2.variables.Summary
Sets the boolean value that indicates if detailed as well as summary information about the charged items category can be sent in the response.
setChargedItemsCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the number of charged items for this patron.
setChargedItemsLimit(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the limit number for charged items for this patron.
setChargePrivilegesDenied(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron's charge privileges are denied.
setCheckin(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if checkin request/response message pair is supported.
setCheckinOk(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the checkinOk value, that tells if the system is allowed to checkin items.
setCheckout(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if checkout request/response message pair is supported.
setCheckoutOk(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the checkoutOk value, that tells if the system is allowed to checkout items.
setCheckSum(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Changes the checksum representing the binary sum of the characters included the message.
setCirculationLocation(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Sets the ILS's circulation location to be used.
setCirculationStatus(CirculationStatus) - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Changes the circulation status of the item.
setCode(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Changes the command identifier of this message
setCollectionCode(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the item collection code.
setCurrencyType(CurrencyType) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the currency type of fees.
setCurrentLocation(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the current location of the item.
setData(String) - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Changes the message data.
setDateTimeSync(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the dateTimeSync value, that tells the date and time of the ILS SIP server. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
setDesensitize(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Sets the value that tells if the system should desensitize the item.
setDesensitizeSupported(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Sets the value that tells if the ILS recognizes that the item should or should not be desensitized.
setDestinationLocation(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the description or identifier for the location where the item should go next.
setDueDate(String) - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Sets the due date for the item.
setEmail(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the email address of the patron.
setEndItem(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Sets the number of the last item to be sent in the list defined by the summary.
setEndPatronSession(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if end patron session request/response pair is supported.
setEndSession(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2EndSessionResponse
Sets the value that tells if the ILS has ended the patron's session.
setErrorDetectionEnabled(boolean) - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Sets the value that defines if the error detection is enabled.
setExcessiveOutstandingFees(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has excessive outstanding fees.
setExcessiveOutstandingFines(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has excessive outstanding fines.
setExpirationDate(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the expiration date of the hold. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
setFeeAcknowledged(boolean) - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Changes the boolean value that tells if the patron has agreed to pay the fee associated with the transaction.
setFeeAmount(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the amount of fees.
setFeeIdentifier(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2FeePaidRequest
Sets the value that identifies a specific fee, possible together with fee type.
setFeeLimit(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the limiting value for fines and fees that the patron is allowed to accumulate in his account.
setFeePaid(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if fee paid request/response message pair is supported.
setFeeType(FeeType) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the fee type.
setFineItems(boolean) - Method in class com.pkrete.jsip2.variables.Summary
Sets the boolean value that indicates if detailed as well as summary information about the fine items category can be sent in the response.
setFineItemsCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the number of fine items for this patron.
setHold(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if hold request/response message pair is supported.
setHoldItems(boolean) - Method in class com.pkrete.jsip2.variables.Summary
Sets the boolean value that indicates if detailed as well as summary information about the hold items category can be sent in the response.
setHoldItemsCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the number of hold items for this patron.
setHoldItemsLimit(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the limit number for hold items for this patron.
setHoldMode(HoldMode) - Method in class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Sets the type of the hold transaction: create, delete or modify.
setHoldPatronId(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the patron id of the patron assigned to the hold for the item.
setHoldPatronName(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the patron name of the patron assigned to the hold for the item.
setHoldPickupDate(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Sets the date that the hold expires.
setHoldPrivilegesDenied(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron's hold privileges are denied.
setHoldQueueLength(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Sets the number of patrons requesting this item.
setHoldType(HoldType) - Method in class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Sets the type of the hold: other, any copy, specific copy or any copy at a single branch or sublocation.
setHomeAddress(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the home address of the patron.
setILSRenewalPolicy(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the ILSRenewalPolicy value, that tells if the system is allowed to process patrons renewal requests.
setInstitutionId(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the library's id.
setIsbn(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Sets the ISBN number of the record that was put on hold.
setItemIdentifier(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the item idetifier.
setItemInformation(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if item information request/response pair is supported.
setItemProperties(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Changes the specific item information that can be used for identifying an item, such as item weight, size, security marker, etc.
setItemPropertiesOk(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemStatusUpdateResponse
Sets the value that tells if the item properties have been stored on the ILS database.
setItems(List<String>) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the lis of item barcodes of the item type defined in the PatronInformationRequest message
setItemStatusUpdate(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if item status update request/response pair is supported.
setItemType(ItemType) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the type of the items in the items list.
setLanguage(Language) - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronRequest
Sets the language.
setLanguage(Language) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Sets the language.
setLccn(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Sets the LCCN number of the record that was put on hold.
setLibraryName(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the libraryName value, that tells the library's name.
setLogin(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if login request/response message pair is supported.
setMagneticMedia(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
Sets the value that tells if the item is magnetic media and the ILS identifies magnetic media.
setMagneticMediaSupported(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
Sets the value that tells if the ILS identifies magnetic media items.
setMaxPrintWidth(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
Changes the maximum number of characters that the system printer can print in one line.
setMediaType(MediaType) - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Sets the media type of the item
setNbDueDate(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Sets the no block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
setNoBlock(boolean) - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Changes the boolean value that tells if the transaction happened when the ILS SIP server was off-line.
setOfflineOk(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the offlineOk value, that tells if the ILS SIP server supports off-line operation feature.
setOk(boolean) - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Sets the value that tells if the requested action was allowable and completed succesfully.
setOnLineStatus(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the online status value of the ILS SIP server.
setOverdueItems(boolean) - Method in class com.pkrete.jsip2.variables.Summary
Sets the boolean value that indicates if detailed as well as summary information about the overdue items category can be sent in the response.
setOverdueItemsCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the number of overdue items for this patron.
setOverdueItemsLimit(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the limit number for overdue items for this patron.
setOwner(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Sets the name of the institution or library that owns the item.
setPacAccessType(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Sets the patron's PAC access level.
setPassword(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Sets the password to login to the ILS.
setPatronEnable(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if request/response message pair is supported.
setPatronGroup(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the code of the patron group in which the patron belongs to.
setPatronIdentifier(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the patron idetifier.
setPatronInformation(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if patron information request/response pair is supported.
setPatronPassword(String) - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Sets the password (PIN) of the patron.
setPatronStatusRequest(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if patron status request message is supported.
setPatronType(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Sets the patron's patron type, such as child, juvenile, adult, etc
setPaymentAccepted(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2FeePaidResponse
Sets the value that tells if the ILS has accepted the payment from the patron.
setPaymentType(PaymentType) - Method in class com.pkrete.jsip2.messages.requests.SIP2FeePaidRequest
Sets the payment type.
setPermanentLocation(String) - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Changes the location where the item is normally stored.
setPersonalName(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Sets the patron name.
setPhone(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the phone number of the patron.
setPickupLocation(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the pickup location of the hold.
setPrintLine(List<String>) - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Sets the printLine value, that's a list of messages received from the ILS to print on the system's printer.
setProtocolVersion(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the protocolVersion value, that tells the protocol version that the ILS SIP version is currently using. 4-char, fixed-length field: x.xx.
setQueuePosition(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Sets the patron's position in the hold queue for an item.
setRecallDate(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Sets the date that the recall was issued.
setRecallItems(boolean) - Method in class com.pkrete.jsip2.variables.Summary
Sets the boolean value that indicates if detailed as well as summary information about the recall items category can be sent in the response.
setRecallItemsCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the number of recall items for this patron.
setRecallOverdue(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has overdue recall.
setRecallPrivilegesDenied(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron's recall privileges are denied.
setRenew(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if renew request/response message pair is supported.
setRenewAll(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if renew all request/response message pair is supported.
setRenewalOk(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Changes the value that tells if the item is already checked out.
setRenewalPrivilegesDenied(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron's renewal privileges are denied.
setRenewedCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Sets the count of the number of items that were renewed.
setRenewedItems(List<String>) - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Sets the list of items that were renewed.
setRequestSCILSResend(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if request SC/ILS resend request/response message pair is supported.
setResensitize(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the value that tells if the item should be resensitized.
setRetriesAllowed(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the retriesAllowed value, that tells the number of retries that are allowed for a specific transaction. 999 indicates that the retry number is unknown.
setReturnDate(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2CheckinRequest
Sets 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.
setSCILSStatus(boolean) - Method in class com.pkrete.jsip2.variables.SupportedMessages
Changes the value that indicates if SC/ILS status request/response message pair is supported.
setScreenMessage(List<String>) - Method in class com.pkrete.jsip2.messages.SIP2MessageResponse
Sets the screenMessage value, that's a list of messages received from the ILS to display on the system's screen.
setScRenewalPolicy(boolean) - Method in class com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest
Changes the boolean value that tells if the system does renewals.
setSecurityInhibit(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Sets the value that tells if the system should ignore the security status of the item.
setSecurityInhibitUsed(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Sets the boolean value that tells if the securityInhibit field was used in the response message received from the ILS SIP server.
setSecurityMarker(SecurityMarker) - Method in class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Changes the security marker of the item.
setSequence(int) - Method in class com.pkrete.jsip2.messages.SIP2Message
Changes the sequence number of the message.
setSocket(Socket) - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Sets the used for the connection with the ILS SIP server.
setSortBin(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Sets the bin number that indicates how the item should be sorted.
setStartItem(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Sets the number of the first item to be sent in the list defined by the summary.
setStatus(PatronStatus) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Sets the patron status value that contains all the information about the patron's status.
setStatusCode(StatusCode) - Method in class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
Changes the status of the system.
setStatusUpdateOk(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the statusUpdateOk value, that tells if the system is allowed to update patron status.
setSummary(Summary) - Method in class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Sets what detailed and summary information of selected category of items that are be requested as a part of this request.
setSupportedMessages(SupportedMessages) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the supportedMessages value, that tells the supported messages by the ILS SIP server.
setTerminalLocation(String) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Sets the terminalLocation value, that tells system's location received from the ILS.
setTerminalPassword(String) - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Sets the password for the system to login to the ILS.
setThirdPartyAllowed(boolean) - Method in class com.pkrete.jsip2.messages.requests.SIP2RenewRequest
Sets the value that tells if third party renewals are allowed.
setTimeoutPeriod(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Changes the timeout period until a transaction is aborted.
setTitleIdentifier(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the identifying value for the title.
setTooManyClaimsOfItemsReturned(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has too many claims of items returned.
setTooManyItemsBilled(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has too many billed items.
setTooManyItemsCharged(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has too many items charged.
setTooManyItemsLost(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has too many lost items.
setTooManyItemsOverdue(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has too many overdue items.
setTooManyRenewals(boolean) - Method in class com.pkrete.jsip2.variables.PatronStatus
Sets the value that tells if the patron has too many renewals.
setTransactionDate(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the transaction date and time.
setTransactionId(String) - Method in class com.pkrete.jsip2.messages.SIP2Message
Sets the transaction id that is assigned by the ILS or by a payment device, for auditing purposes to track cash flow.
setUnavailableHolds(boolean) - Method in class com.pkrete.jsip2.variables.Summary
Sets the boolean value that indicates if detailed as well as summary information about the unavailable holds category can be sent in the response.
setUnavailableHoldsCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Changes the number of unavailable holds for this patron.
setUnrenewedCount(int) - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Sets the count of the number of items that were not renewed.
setUnrenewedItems(List<String>) - Method in class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Returns the list of items that were not renewed.
setUseCancel(boolean) - Method in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Sets the value that tells if the cancel field should be added to the request.
setUseFeeAcknowledged(boolean) - Method in class com.pkrete.jsip2.messages.SIP2MessageRequest
Sets the value that tells if the fee acknowledged field should be added to the request.
setUserName(String) - Method in class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Sets the username to login to the ILS.
setValidPatron(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Sets the boolean value that tells if the patron barcode is valid.
setValidPatronPassword(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Sets the boolean value that tells if the patron password is valid.
setValidPatronPasswordUsed(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Sets the boolean value that tells if the valid patron password field was used in the response message received from the ILS SIP server.
setValidPatronUsed(boolean) - Method in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Sets the boolean value that tells if the valid patron field was used in the response message received from the ILS SIP server.
SIP2ACSStatusResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response message that the ILS SIP server must send in response to the SIP2SCStatusRequest message.
SIP2ACSStatusResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse
Constructs and initializes a new SIP2ACSStatusResponse object containing the given data.
SIP2ACSStatusResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2ACSStatusResponse objects.
SIP2ACSStatusResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2ACSStatusResponseParser
 
SIP2BlockPatronRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to request the ILS to block the patron card.
SIP2CheckinRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to checkin an item, and also to cancel a SIP2CheckoutRequest that did not succesfully complete.
SIP2CheckinRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckinRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckinRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckinRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckinRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckinRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckinRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckinRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckinResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response message that the ILS SIP server must send in response to the SIP2CheckinRequest message.
SIP2CheckinResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2CheckinResponse
Constructs and initializes a new SIP2CheckinResponse object containing the given data.
SIP2CheckinResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2CheckinResponse objects.
SIP2CheckinResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2CheckinResponseParser
 
SIP2CheckoutRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to checkout an item, and also to cancel a SIP2CheckinRequest that did not succesfully complete.
SIP2CheckoutRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckoutRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckoutRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckoutRequest(String, String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest
Constructs and initializes a new SIP2CheckoutRequest object with the given values.
SIP2CheckoutResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response message that the ILS SIP server must send in response to the SIP2CheckoutRequest message.
SIP2CheckoutResponse(String, String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Constructs and initializes a new SIP2CheckoutResponse object containing the given data.
SIP2CheckoutResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse
Constructs and initializes a new SIP2CheckoutResponse object containing the given data.
SIP2CheckoutResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2CheckoutResponse objects.
SIP2CheckoutResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2CheckoutResponseParser
 
SIP2CirculationTransactionRequest - Class in com.pkrete.jsip2.messages.requests
This abstract class is a base class of the SIP2CheckoutRequest and the SIP2CheckinRequest classes.
SIP2CirculationTransactionRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Constructs and initializes a new SIP2CirculationTransactionRequestt with the given command code.
SIP2CirculationTransactionResponse - Class in com.pkrete.jsip2.messages.responses
This abstract class is a base class of the SIP2CheckoutResponse and the SIP2CheckinResponse classes.
SIP2CirculationTransactionResponse(String, String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
Constructs and initializes a new SIP2CirculationTransactionResponse object containing the given data.
SIP2EndPatronSessionRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is sent when a patron has completed all their transactions.
SIP2EndPatronSessionRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2EndPatronSessionRequest
Constructs and initializes a new SIP2EndPatronSessionRequest object with the given values.
SIP2EndPatronSessionRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2EndPatronSessionRequest
Constructs and initializes a new SIP2EndPatronSessionRequest object with the given values.
SIP2EndSessionResponse - Class in com.pkrete.jsip2.messages.responses
The ILS must send this message in response to the SIP2EndPatronSessionRequest message.
SIP2EndSessionResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2EndSessionResponse
Constructs and initializes a new SIP2EndSessionResponse object containing the given data.
SIP2EndSessionResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2EndSessionResponse objects.
SIP2EndSessionResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2EndSessionResponseParser
 
SIP2FeePaidRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that can be used to notify the ILS that a fee has been collected from the patron.
SIP2FeePaidRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2FeePaidRequest
Constructs and initializes a new SIP2FeePaidRequest object with the given values.
SIP2FeePaidRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2FeePaidRequest
Constructs and initializes a new SIP2FeePaidRequest object with the given values.
SIP2FeePaidResponse - Class in com.pkrete.jsip2.messages.responses
The ILS must send this message in response to the SIP2FeePaidRequest message.
SIP2FeePaidResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2FeePaidResponse
Constructs and initializes a new SIP2FeePaidResponse object containing the given data.
SIP2FeePaidResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2FeePaidResponse objects.
SIP2FeePaidResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2FeePaidResponseParser
 
SIP2HoldRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that can is used to create, modify, or delete a hold.
SIP2HoldRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Constructs and initializes a new SIP2HoldRequest object with the given values.
SIP2HoldRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Constructs and initializes a new SIP2HoldRequest object with the given values.
SIP2HoldRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Constructs and initializes a new SIP2HoldRequest object with the given values.
SIP2HoldRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2HoldRequest
Constructs and initializes a new SIP2HoldRequest object with the given values.
SIP2HoldResponse - Class in com.pkrete.jsip2.messages.responses
The ILS must send this message in response to the SIP2HoldRequest message.
SIP2HoldResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2HoldResponse
Constructs and initializes a new SIP2HoldResponse object containing the given data.
SIP2HoldResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2HoldResponse objects.
SIP2HoldResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2HoldResponseParser
 
SIP2ItemInformationRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to request item information.
SIP2ItemInformationRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2ItemInformationRequest
Constructs and initializes a new SIP2ItemInformationRequest object with the given values.
SIP2ItemInformationRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2ItemInformationRequest
Constructs and initializes a new SIP2ItemInformationRequest object with the given values.
SIP2ItemInformationRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2ItemInformationRequest
Constructs and initializes a new SIP2ItemInformationRequest object with the given values.
SIP2ItemInformationResponse - Class in com.pkrete.jsip2.messages.responses
The ILS must send this message in response to the SIP2ItemInformationRequest message.
SIP2ItemInformationResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse
Constructs and initializes a new SIP2ItemInformationResponse object containing the given data.
SIP2ItemInformationResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2ItemInformationResponse objects.
SIP2ItemInformationResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2ItemInformationResponseParser
 
SIP2ItemStatusUpdateRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to send item information to the ILS, without having to do a checkout or checkin operation.
SIP2ItemStatusUpdateRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2ItemStatusUpdateRequest
Constructs and initializes a new SIP2ItemStatusUpdateRequest object with the given values.
SIP2ItemStatusUpdateRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2ItemStatusUpdateRequest
Constructs and initializes a new SIP2ItemStatusUpdateRequest object with the given values.
SIP2ItemStatusUpdateRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2ItemStatusUpdateRequest
Constructs and initializes a new SIP2ItemStatusUpdateRequest object with the given values.
SIP2ItemStatusUpdateResponse - Class in com.pkrete.jsip2.messages.responses
The ILS must send this message in response to the SIP2ItemStatusUpdateRequest message.
SIP2ItemStatusUpdateResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2ItemStatusUpdateResponse
Constructs and initializes a new SIP2ItemStatusUpdateResponse object containing the given data.
SIP2ItemStatusUpdateResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2ItemStatusUpdateResponse objects.
SIP2ItemStatusUpdateResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2ItemStatusUpdateResponseParser
 
SIP2LoginRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to login to an ILS SIP server program.
SIP2LoginRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Constructs and initializes a new SIP2LoginRequest object with the given userName and password.
SIP2LoginRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2LoginRequest
Constructs and initializes a new SIP2LoginRequest object with the given userName, password, and circulationLocation.
SIP2LoginResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response that the ILS SIP server should send in response to the SIP2LoginRequest message.
SIP2LoginResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2LoginResponse
Constructs and initializes a new SIP2LoginResponse object containing the given data.
SIP2LoginResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2LoginResponse objects.
SIP2LoginResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2LoginResponseParser
 
SIP2Message - Class in com.pkrete.jsip2.messages
This abstract class is a base class for all the SIP2 request and response messages.
SIP2Message(String) - Constructor for class com.pkrete.jsip2.messages.SIP2Message
Constructs and initializes a new SIP2Message object.
SIP2MessageRequest - Class in com.pkrete.jsip2.messages
This abstract class is a base class of the SIP2 request messages sent to the ILS SIP server.
SIP2MessageRequest(String) - Constructor for class com.pkrete.jsip2.messages.SIP2MessageRequest
Constructs and initializes a new SIP2MessageRequest object with the given command identifier and sets the transacation date.
SIP2MessageResponse - Class in com.pkrete.jsip2.messages
This abstract class is a base class of the SIP2 response messages received from the ILS SIP server.
SIP2MessageResponse(String, String) - Constructor for class com.pkrete.jsip2.messages.SIP2MessageResponse
Constructs and initializes a new SIP2MessageResponse object.
SIP2PatronEnableRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that can be used to re-enable canceled patrons.
SIP2PatronEnableRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronEnableRequest
Constructs and initializes a new SIP2PatronEnableRequest object with the given values.
SIP2PatronEnableRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronEnableRequest
Constructs and initializes a new SIP2PatronEnableRequest object with the given values.
SIP2PatronEnableRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronEnableRequest
Constructs and initializes a new SIP2PatronEnableRequest object with the given values.
SIP2PatronEnableRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronEnableRequest
Constructs and initializes a new SIP2PatronEnableRequest object with the given values.
SIP2PatronEnableResponse - Class in com.pkrete.jsip2.messages.responses
The ILS must send this message in response to the SIP2PatronEnableRequest message.
SIP2PatronEnableResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2PatronEnableResponse
Constructs and initializes a new SIP2PatronEnableResponse object containing the given data.
SIP2PatronEnableResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2PatronEnableResponse objects.
SIP2PatronEnableResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2PatronEnableResponseParser
 
SIP2PatronInformationRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to request detailedd patron information from the ILS SIP server, and this class extends the SIP2PatronRequest message.
SIP2PatronInformationRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Constructs and initializes a new PatronInformationRequest message with the given parameters.
SIP2PatronInformationRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Constructs and initializes a new PatronInformationRequest message with the given parameters.
SIP2PatronInformationRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Constructs and initializes a new PatronInformationRequest message with the given parameters.
SIP2PatronInformationRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest
Constructs and initializes a new PatronInformationRequest message with the given parameters.
SIP2PatronInformationResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response message that the ILS SIP server must send in response to the SIP2PatronInformationRequest message}.
SIP2PatronInformationResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse
Constructs and initializes a new SIP2PatronInformationResponse object containing the given data.
SIP2PatronInformationResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2PatronInformationResponse objects.
SIP2PatronInformationResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2PatronInformationResponseParser
 
SIP2PatronRequest - Class in com.pkrete.jsip2.messages.requests
This abstract class is a base class of the SIP2PatronStatusRequest and the SIP2PatronInformationRequest classes.
SIP2PatronRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronRequest
Constructs and initializes a new SIP2PatronRequest with the given command code.
SIP2PatronResponse - Class in com.pkrete.jsip2.messages.responses
This abstract class is a base class of the SIP2PatronStatusResponse and the SIP2PatronInformationResponse classes.
SIP2PatronResponse(String, String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Constructs and initializes a new SIP2PatronStatusResponse object containing the given data.
SIP2PatronStatusRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to request the patron information from the ILS SIP server.
SIP2PatronStatusRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronStatusRequest
Constructs and initializes a new SIP2PatronStatusRequest message with the given parameters.
SIP2PatronStatusRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronStatusRequest
Constructs and initializes a new SIP2PatronStatusRequest message with the given parameters.
SIP2PatronStatusRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronStatusRequest
Constructs and initializes a new SIP2PatronStatusRequest message with the given parameters.
SIP2PatronStatusRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2PatronStatusRequest
Constructs and initializes a new SIP2PatronStatusRequest message with the given parameters.
SIP2PatronStatusResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response message that the ILS SIP server must send in response to the SIP2PatronStatusRequest message as well as in response to the SIP2BlockPatronRequest.
SIP2PatronStatusResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2PatronStatusResponse
Constructs and initializes a new SIP2PatronStatusResponse object containing the given data.
SIP2PatronStatusResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2PatronStatusResponse objects.
SIP2PatronStatusResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2PatronStatusResponseParser
 
SIP2RenewAllRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to renew all items that the patron has checked out.
SIP2RenewAllRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewAllRequest
Constructs and initializes a new SIP2RenewAllRequest object with the given values.
SIP2RenewAllRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewAllRequest
Constructs and initializes a new SIP2RenewAllRequest object with the given values.
SIP2RenewAllRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewAllRequest
Constructs and initializes a new SIP2RenewAllRequest object with the given values.
SIP2RenewAllRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewAllRequest
Constructs and initializes a new SIP2RenewAllRequest object with the given values.
SIP2RenewAllResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response message that the ILS SIP server must send in response to the SIP2RenewAllRequest message.
SIP2RenewAllResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2RenewAllResponse
Constructs and initializes a new SIP2RenewAllResponse object containing the given data.
SIP2RenewAllResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2RenewAllResponse objects.
SIP2RenewAllResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2RenewAllResponseParser
 
SIP2RenewRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the message that is used to renew an item.
SIP2RenewRequest(String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewRequest
Constructs and initializes a new SIP2RenewRequest object with the given values.
SIP2RenewRequest(String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewRequest
Constructs and initializes a new SIP2RenewRequest object with the given values.
SIP2RenewRequest(String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewRequest
Constructs and initializes a new SIP2RenewRequest object with the given values.
SIP2RenewRequest(String, String, String, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RenewRequest
Constructs and initializes a new SIP2RenewRequest object with the given values.
SIP2RenewResponse - Class in com.pkrete.jsip2.messages.responses
This class represents the response message that the ILS SIP server must send in response to the SIP2RenewRequest message.
SIP2RenewResponse(String) - Constructor for class com.pkrete.jsip2.messages.responses.SIP2RenewResponse
Constructs and initializes a new SIP2CheckoutResponse object containing the given data.
SIP2RenewResponseParser - Class in com.pkrete.jsip2.parser
This class parses the data received from the ILS SIP server and generates SIP2RenewResponse objects.
SIP2RenewResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2RenewResponseParser
 
SIP2RequestResend - Class in com.pkrete.jsip2.messages.requests
This class represent the message that is used to request the ILS to re-transmit its last message.
SIP2RequestResend() - Constructor for class com.pkrete.jsip2.messages.requests.SIP2RequestResend
Constructs and initializes a new SIP2RequestResend object.
SIP2ResponseFactory - Class in com.pkrete.jsip2.messages
This class generates SIP2MessageResponse objects based on the data received from the ILS SIP server.
SIP2ResponseParser - Class in com.pkrete.jsip2.parser
This is an abstract base class for all the response message parser classes, which task is to parse the response messages received from the ILS SIP server and create the corresponding objects.
SIP2ResponseParser() - Constructor for class com.pkrete.jsip2.parser.SIP2ResponseParser
 
SIP2SCStatusRequest - Class in com.pkrete.jsip2.messages.requests
This class represents the request that sends the current status of the system to the ILS SIP server, which replies with the SIP2ACSStatusResponse message.
SIP2SCStatusRequest() - Constructor for class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
Constructs and initializes a new SIP2SCStatusRequest object.
SIP2SCStatusRequest(StatusCode) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
Constructs and initializes a new SIP2SCStatusRequest object with the given status code.
SIP2SCStatusRequest(StatusCode, String) - Constructor for class com.pkrete.jsip2.messages.requests.SIP2SCStatusRequest
Constructs and initializes a new SIP2SCStatusRequest object with the given status code and max print width.
SIP2SocketConnection - Class in com.pkrete.jsip2.connection
This class is responsible of the communication between the system and the ILS SIP server.
SIP2SocketConnection(String, int) - Constructor for class com.pkrete.jsip2.connection.SIP2SocketConnection
Constructs and initializes a new SIP2SocketConnection object with the given host and port.
SIP2SocketConnection(String, int, int) - Constructor for class com.pkrete.jsip2.connection.SIP2SocketConnection
Constructs and initializes a new SIP2SocketConnection object with the given host, port and timeout.
status - Variable in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Patron's status.
StatusCode - Enum in com.pkrete.jsip2.variables
This enum represents the status of the SC unit.
stringToInt(String) - Method in class com.pkrete.jsip2.parser.SIP2ResponseParser
Converts the given string to an integer.
StringUtil - Class in com.pkrete.jsip2.util
This class offers methods that are needed for handling strings.
StringUtil() - Constructor for class com.pkrete.jsip2.util.StringUtil
 
Summary - Class in com.pkrete.jsip2.variables
This class represents a summary that can be requested as a part of the SIP2PatronInformationRequest.
Summary() - Constructor for class com.pkrete.jsip2.variables.Summary
Constructs and initializes a new Summary object with all the boolean values set to false.
SupportedMessages - Class in com.pkrete.jsip2.variables
This class represents the supported messages information that is received as a part of the SIPSCStatusResponse response message.
SupportedMessages() - Constructor for class com.pkrete.jsip2.variables.SupportedMessages
 

T

terminalPassword - Variable in class com.pkrete.jsip2.messages.SIP2MessageRequest
Password for the system to login to the ILS.
titleIdentifier - Variable in class com.pkrete.jsip2.messages.SIP2Message
Identifying value for the title.
toSipDateTime(Date) - Static method in class com.pkrete.jsip2.util.MessageUtil
Converts the given date to a SIP2 formatted date/time string.
toString() - Method in enum com.pkrete.jsip2.variables.AlertType
 
toString() - Method in enum com.pkrete.jsip2.variables.CirculationStatus
 
toString() - Method in enum com.pkrete.jsip2.variables.CurrencyType
 
toString() - Method in enum com.pkrete.jsip2.variables.FeeType
 
toString() - Method in enum com.pkrete.jsip2.variables.HoldMode
 
toString() - Method in enum com.pkrete.jsip2.variables.HoldType
 
toString() - Method in enum com.pkrete.jsip2.variables.ItemType
 
toString() - Method in enum com.pkrete.jsip2.variables.Language
 
toString() - Method in enum com.pkrete.jsip2.variables.MediaType
 
toString() - Method in class com.pkrete.jsip2.variables.PatronStatus
Returns a String presentation of this PatronStatus object.
toString() - Method in enum com.pkrete.jsip2.variables.PaymentType
 
toString() - Method in enum com.pkrete.jsip2.variables.SecurityMarker
 
toString() - Method in enum com.pkrete.jsip2.variables.StatusCode
 
toString() - Method in class com.pkrete.jsip2.variables.Summary
 
transactionDate - Variable in class com.pkrete.jsip2.messages.SIP2Message
Date and time of the request. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
transactionId - Variable in class com.pkrete.jsip2.messages.SIP2Message
A transaction id that is assigned by the ILS or by a payment device, for auditing purposes to track cash flow.

U

useCancel - Variable in class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
Tells if cancel field show be added to the request, as the field is optional.
useFeeAcknowledged - Variable in class com.pkrete.jsip2.messages.SIP2MessageRequest
Tells if fee acknowledged field show be added to the request.

V

validPatron - Variable in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Indicates if the patron barcode is valid.
validPatronPassword - Variable in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Indicates if the patron password is valid.
validPatronPasswordUsed - Variable in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Indicates if the validPatronPassword value was used in the response received from the ILS SIP server.
validPatronUsed - Variable in class com.pkrete.jsip2.messages.responses.SIP2PatronResponse
Indicates if the validPatron value was used in the response received from the ILS SIP server.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.AlertType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.CirculationStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.CurrencyType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.FeeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.HoldMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.HoldType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.ItemType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.Language
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.MediaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.PaymentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.SecurityMarker
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pkrete.jsip2.variables.StatusCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.pkrete.jsip2.variables.AlertType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.CirculationStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.CurrencyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.FeeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.HoldMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.HoldType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.ItemType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.Language
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.MediaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.PaymentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.SecurityMarker
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pkrete.jsip2.variables.StatusCode
Returns an array containing the constants of this enum type, in the order they are declared.

W

write(String) - Method in class com.pkrete.jsip2.connection.SIP2SocketConnection
Sends the given string to the ILS SIP server.

A B C D E F G H I L M N O P R S T U V W

Copyright © 2012-2014. All Rights Reserved.