com.pkrete.jsip2.messages.requests
Class SIP2CheckinRequest

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

All Implemented Interfaces:

Serializable

public class SIP2CheckinRequest
extends SIP2CirculationTransactionRequest

This class represents the message that is used to checkin an item, and also to cancel a SIP2CheckoutRequest that did not succesfully complete. The ILS SIP server must respond with the SIP2CheckinResponse 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

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

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

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

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

Method Summary

String	getData() Returns a string presentation of the message.
String	getReturnDate() 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.
void	setReturnDate(String returnDate) 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.

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

SIP2CheckinRequest

public SIP2CheckinRequest(String itemId)

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

Parameters:

itemId - an identifying value for the item

SIP2CheckinRequest

public SIP2CheckinRequest(String location,
                          String itemId)

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

Parameters:

location - current location of the item

itemId - an identifying value for the item

SIP2CheckinRequest

public SIP2CheckinRequest(String location,
                          String institutionId,
                          String itemId)

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

Parameters:

location - current location of the item

institutionId - library's institution id

itemId - an identifying value for the item

SIP2CheckinRequest

public SIP2CheckinRequest(String location,
                          String terminalPassword,
                          String institutionId,
                          String itemId)

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

Parameters:

location - current location of the item

terminalPassword - passwort to login the ILS

institutionId - library's institution id

itemId - an identifying value for the item

Method Detail

getReturnDate

public String getReturnDate()

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.

Returns:

date that an item was returned to the library

setReturnDate

public void setReturnDate(String returnDate)

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.

Parameters:

returnDate - 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