com.pkrete.jsip2.messages.requests
Class SIP2CheckoutRequest

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageRequest
          com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
              com.pkrete.jsip2.messages.requests.SIP2CheckoutRequest

All Implemented Interfaces:

Serializable

public class SIP2CheckoutRequest
extends SIP2CirculationTransactionRequest

This class represents the message that is used to checkout an item, and also to cancel a SIP2CheckinRequest that did not succesfully complete. The ILS SIP server must respond with the SIP2CheckoutResponse message. This class extends the abstract SIP2CirculationTransactionRequest class.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

Fields inherited from class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest

cancel, nbDueDate, noBlock, useCancel

Fields inherited from class com.pkrete.jsip2.messages.SIP2MessageRequest

counter, errorDetectionEnabled, feeAcknowledged, patronPassword, terminalPassword, useFeeAcknowledged

Fields inherited from class com.pkrete.jsip2.messages.SIP2Message

bibId, checkSum, code, currencyType, currentLocation, expirationDate, feeAmount, feeType, institutionId, itemIdentifier, itemProperties, patronIdentifier, pickupLocation, sequence, titleIdentifier, transactionDate, transactionId

Constructor Summary

SIP2CheckoutRequest(String patronId, String itemId)
Constructs and initializes a new SIP2CheckoutRequest object with the given values.

SIP2CheckoutRequest(String institutionId, String patronId, String itemId)
Constructs and initializes a new SIP2CheckoutRequest object with the given values.

SIP2CheckoutRequest(String institutionId, String patronId, String patronPassword, String itemId)
Constructs and initializes a new SIP2CheckoutRequest object with the given values.

SIP2CheckoutRequest(String institutionId, String terminalPassword, String patronId, String patronPassword, String itemId)
Constructs and initializes a new SIP2CheckoutRequest object with the given values.

Method Summary

String	getData() Returns a string presentation of the message.
boolean	isScRenewalPolicy() Returns true if and only if the system has been configured to do renewals, otherwise return false.
void	setScRenewalPolicy(boolean scRenewalPolicy) Changes the boolean value that tells if the system does renewals.

Methods inherited from class com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest

getNbDueDate, isCancel, isNoBlock, isUseCancel, setCancel, setNbDueDate, setNoBlock, setUseCancel

Methods inherited from class com.pkrete.jsip2.messages.SIP2MessageRequest

getCheckSum, getPatronPassword, getTerminalPassword, isErrorDetectionEnabled, isFeeAcknowledged, isUseFeeAcknowledged, setErrorDetectionEnabled, setFeeAcknowledged, setPatronPassword, setTerminalPassword, setUseFeeAcknowledged

Methods inherited from class com.pkrete.jsip2.messages.SIP2Message

getBibId, getCode, getCurrencyType, getCurrentLocation, getExpirationDate, getFeeAmount, getFeeType, getInstitutionId, getItemIdentifier, getItemProperties, getPatronIdentifier, getPickupLocation, getSequence, getTitleIdentifier, getTransactionDate, getTransactionId, isChecksum, isSequence, setBibId, setCheckSum, setCode, setCurrencyType, setCurrentLocation, setExpirationDate, setFeeAmount, setFeeType, setInstitutionId, setItemIdentifier, setItemProperties, setPatronIdentifier, setPickupLocation, setSequence, setTitleIdentifier, setTransactionDate, setTransactionId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SIP2CheckoutRequest

public SIP2CheckoutRequest(String patronId,
                           String itemId)

Constructs and initializes a new SIP2CheckoutRequest object with the given values.

Parameters:

patronId - an identifying value for the patron

itemId - an identifying value for the item

SIP2CheckoutRequest

public SIP2CheckoutRequest(String institutionId,
                           String patronId,
                           String itemId)

Constructs and initializes a new SIP2CheckoutRequest object with the given values.

Parameters:

institutionId - library's institution id

patronId - an identifying value for the patron

itemId - an identifying value for the item

SIP2CheckoutRequest

public SIP2CheckoutRequest(String institutionId,
                           String patronId,
                           String patronPassword,
                           String itemId)

Constructs and initializes a new SIP2CheckoutRequest object with the given values.

Parameters:

institutionId - library's institution id

patronId - an identifying value for the patron

patronPassword - password (PIN) of the patron

itemId - an identifying value for the item

SIP2CheckoutRequest

public SIP2CheckoutRequest(String institutionId,
                           String terminalPassword,
                           String patronId,
                           String patronPassword,
                           String itemId)

Constructs and initializes a new SIP2CheckoutRequest object with the given values.

Parameters:

institutionId - library's institution id

terminalPassword - password to login the ILS

patronId - an identifying value for the patron

patronPassword - password (PIN) of the patron

itemId - an identifying value for the item

Method Detail

isScRenewalPolicy

public boolean isScRenewalPolicy()

Returns true if and only if the system has been configured to do renewals, otherwise return false.

Returns:

true if the system has been configured to do renewals, otherwise false

setScRenewalPolicy

public void setScRenewalPolicy(boolean scRenewalPolicy)

Changes the boolean value that tells if the system does renewals.

Parameters:

scRenewalPolicy - new value

getData

public String getData()

Description copied from class: SIP2Message

Returns a string presentation of the message.

Specified by:

getData in class SIP2Message

Returns:

string presentation of the message