com.pkrete.jsip2.messages.responses
Class SIP2HoldResponse

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageResponse
          com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
              com.pkrete.jsip2.messages.responses.SIP2HoldResponse

All Implemented Interfaces:

Serializable

public class SIP2HoldResponse
extends SIP2CirculationTransactionResponse

The ILS must send this message in response to the SIP2HoldRequest message.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

Fields inherited from class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse

magneticMedia, magneticMediaSupported

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

data, dueDate, mediaType, ok, permanentLocation, printLine, screenMessage

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

SIP2HoldResponse(String data)
Constructs and initializes a new SIP2HoldResponse object containing the given data.

Method Summary

String	countChecksum() Counts the chekcsum of this response message.
String	getIsbn() Returns the ISBN number of the record that was put on hold.
String	getLccn() Returns the LCCN number of the record that was put on hold.
String	getQueuePosition() Returns a numeric value for the patron's position in the hold queue for an item.
boolean	isAvailable() Returns true if and only if the item is available, it's not checked out or on hold.
void	setAvailable(boolean available) Sets the value that tells the item is available.
void	setIsbn(String isbn) Sets the ISBN number of the record that was put on hold.
void	setLccn(String lccn) Sets the LCCN number of the record that was put on hold.
void	setQueuePosition(String queuePosition) Sets the patron's position in the hold queue for an item.

Methods inherited from class com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse

isMagneticMedia, isMagneticMediaSupported, setMagneticMedia, setMagneticMediaSupported

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

getData, getDueDate, getMediaType, getPermanentLocation, getPrintLine, getScreenMessage, isOk, isValid, setData, setDueDate, setMediaType, setOk, setPermanentLocation, setPrintLine, setScreenMessage

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

getBibId, getCheckSum, 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

SIP2HoldResponse

public SIP2HoldResponse(String data)

Constructs and initializes a new SIP2HoldResponse object containing the given data.

Parameters:

data - the data that the message contains

Method Detail

isAvailable

public boolean isAvailable()

Returns true if and only if the item is available, it's not checked out or on hold.

Returns:

true the item is available, otherwise false

setAvailable

public void setAvailable(boolean available)

Sets the value that tells the item is available.

Parameters:

available - true or false

getQueuePosition

public String getQueuePosition()

Returns a numeric value for the patron's position in the hold queue for an item.

Returns:

numeric value for the patron's position in the hold queue for an item

setQueuePosition

public void setQueuePosition(String queuePosition)

Sets the patron's position in the hold queue for an item.

Parameters:

queuePosition - numeric value

getIsbn

public String getIsbn()

Returns the ISBN number of the record that was put on hold. This is an extension field and it's not included in the original SIP2 definition.

Returns:

ISBN number of the record that was put on hold

setIsbn

public void setIsbn(String isbn)

Sets the ISBN number of the record that was put on hold. This is an extension field and it's not included in the original SIP2 definition.

Parameters:

isbn - ISBN number

getLccn

public String getLccn()

Returns the LCCN number of the record that was put on hold. This is a Voyager ESIP extension and it's not included in the original SIP2 definition.

Returns:

LCCN number of the record that was put on hold

setLccn

public void setLccn(String lccn)

Sets the LCCN number of the record that was put on hold. This is a Voyager ESIP extension and it's not included in the original SIP2 definition.

Parameters:

lccn - LCCN number

countChecksum

public String countChecksum()

Counts the chekcsum of this response message.

Specified by:

countChecksum in class SIP2MessageResponse

Returns:

checksum