com.pkrete.jsip2.messages.responses
Class SIP2ItemInformationResponse

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageResponse
          com.pkrete.jsip2.messages.responses.SIP2ItemInformationResponse

All Implemented Interfaces:

Serializable

public class SIP2ItemInformationResponse
extends SIP2MessageResponse

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

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

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

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

Method Summary

String	countChecksum() Counts the chekcsum of this response message.
CirculationStatus	getCirculationStatus() Returns the circulation status of the item.
String	getHoldPickupDate() Returns the date that the hold expires. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
String	getHoldQueueLength() Returns the number of patrons requesting this item.
String	getOwner() Returns the name of the institution or library that owns the item.
String	getRecallDate() Returns the date that the recall was issued. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
SecurityMarker	getSecurityMarker() Returns the security marker of the item.
void	setCirculationStatus(CirculationStatus circulationStatus) Changes the circulation status of the item.
void	setHoldPickupDate(String holdPickupDate) Sets the date that the hold expires.
void	setHoldQueueLength(String holdQueueLength) Sets the number of patrons requesting this item.
void	setOwner(String owner) Sets the name of the institution or library that owns the item.
void	setRecallDate(String recallDate) Sets the date that the recall was issued.
void	setSecurityMarker(SecurityMarker securityMarker) Changes the security marker of the item.

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

SIP2ItemInformationResponse

public SIP2ItemInformationResponse(String data)

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

Parameters:

data - the data that the message contains

Method Detail

getCirculationStatus

public CirculationStatus getCirculationStatus()

Returns the circulation status of the item.

Returns:

circulation status

setCirculationStatus

public void setCirculationStatus(CirculationStatus circulationStatus)

Changes the circulation status of the item.

Parameters:

circulationStatus - new status

getSecurityMarker

public SecurityMarker getSecurityMarker()

Returns the security marker of the item.

Returns:

security marker

setSecurityMarker

public void setSecurityMarker(SecurityMarker securityMarker)

Changes the security marker of the item.

Parameters:

securityMarker - new security marker

getHoldQueueLength

public String getHoldQueueLength()

Returns the number of patrons requesting this item.

Returns:

number of patrons requesting this item

setHoldQueueLength

public void setHoldQueueLength(String holdQueueLength)

Sets the number of patrons requesting this item.

Parameters:

holdQueueLength - new hold queue length

getOwner

public String getOwner()

Returns the name of the institution or library that owns the item.

Returns:

name of the institution or library that owns the item

setOwner

public void setOwner(String owner)

Sets the name of the institution or library that owns the item.

Parameters:

owner - new owner

getRecallDate

public String getRecallDate()

Returns the date that the recall was issued. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.

Returns:

date that the recall was issued

setRecallDate

public void setRecallDate(String recallDate)

Sets the date that the recall was issued.

Parameters:

recallDate - new recall date, 18-char, fixed-length: YYYYMMDDZZZZHHMMSS

getHoldPickupDate

public String getHoldPickupDate()

Returns the date that the hold expires. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.

Returns:

the date that the hold expires.

setHoldPickupDate

public void setHoldPickupDate(String holdPickupDate)

Sets the date that the hold expires.

Parameters:

holdPickupDate - new hold pickup date, 18-char, fixed-length: YYYYMMDDZZZZHHMMSS

countChecksum

public String countChecksum()

Counts the chekcsum of this response message.

Specified by:

countChecksum in class SIP2MessageResponse

Returns:

checksum