com.pkrete.jsip2.messages.responses
Class SIP2CheckinResponse

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

All Implemented Interfaces:

Serializable

public class SIP2CheckinResponse
extends SIP2CirculationTransactionResponse

This class represents the response message that the ILS SIP server must send in response to the SIP2CheckinRequest 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

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

Method Summary

String	countChecksum() Counts the chekcsum of this response message.
AlertType	getAlertType() Return the type of the alert.
String	getCallNumber() Returns the code which indicates the item's permanent physical location.
String	getCollectionCode() Returns the item collection code.
String	getDestinationLocation() Returns the description or identifier for the location where the item should go next.
String	getHoldPatronId() Returns the patron id of the patron assigned to the hold for the item.
String	getHoldPatronName() Returns the patron name of the patron assigned to the hold for the item.
String	getSortBin() Returns the bin number that indicates how the item should be sorted.
boolean	isAlert() Returns true if and only if there's an alert related to the item or the the patron.
boolean	isResensitize() Returns true if and only if the item should be resensitized.
void	setAlert(boolean alert) Sets the value that tells if there's an alert related to the item or the the patron.
void	setAlertType(AlertType alertType) Sets the type of the alert.
void	setCallNumber(String callNumber) Sets the code which indicates the item's permanent physical location.
void	setCollectionCode(String collectionCode) Sets the item collection code.
void	setDestinationLocation(String destinationLocation) Sets the description or identifier for the location where the item should go next.
void	setHoldPatronId(String holdPatronId) Sets the patron id of the patron assigned to the hold for the item.
void	setHoldPatronName(String holdPatronName) Sets the patron name of the patron assigned to the hold for the item.
void	setResensitize(boolean resensitize) Sets the value that tells if the item should be resensitized.
void	setSortBin(String sortBin) Sets the bin number that indicates how the item should be sorted.

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

SIP2CheckinResponse

public SIP2CheckinResponse(String data)

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

Parameters:

data - the data that the message contains

Method Detail

isResensitize

public boolean isResensitize()

Returns true if and only if the item should be resensitized.

Returns:

true if the item should be resensitized, otherwise false

setResensitize

public void setResensitize(boolean resensitize)

Sets the value that tells if the item should be resensitized.

Parameters:

resensitize - true or false

isAlert

public boolean isAlert()

Returns true if and only if there's an alert related to the item or the the patron. The alert indicates conditions like items on hold, items belonging to another library branch, or other alert conditions as determined by the ILS.

Returns:

if there's an alert related to the item or the the patron, otherwise false

setAlert

public void setAlert(boolean alert)

Sets the value that tells if there's an alert related to the item or the the patron.

Parameters:

alert - true or false

getSortBin

public String getSortBin()

Returns the bin number that indicates how the item should be sorted.

Returns:

bin number that indicates how the item should be sorted

setSortBin

public void setSortBin(String sortBin)

Sets the bin number that indicates how the item should be sorted.

Parameters:

sortBin - new bin number

getCollectionCode

public String getCollectionCode()

Returns the item collection code. Collection codes represent a set of item within library or a location for a group of item. One use of this field is in sortation systems for high level sorting of materials.

Returns:

collection code

setCollectionCode

public void setCollectionCode(String collectionCode)

Sets the item collection code. Collection codes represent a set of item within library or a location for a group of item. One use of this field is in sortation systems for high level sorting of materials.

Parameters:

collectionCode - new collection code

getCallNumber

public String getCallNumber()

Returns the code which indicates the item's permanent physical location.

Returns:

code which indicates the item's permanent physical location

setCallNumber

public void setCallNumber(String callNumber)

Sets the code which indicates the item's permanent physical location.

Parameters:

callNumber - new code

getDestinationLocation

public String getDestinationLocation()

Returns the description or identifier for the location where the item should go next.

Returns:

description or identifier for the location where the item should go next.

setDestinationLocation

public void setDestinationLocation(String destinationLocation)

Sets the description or identifier for the location where the item should go next.

Parameters:

destinationLocation - new location

getAlertType

public AlertType getAlertType()

Return the type of the alert.

Returns:

type of the alert

setAlertType

public void setAlertType(AlertType alertType)

Sets the type of the alert.

Parameters:

alertType - new alert type

getHoldPatronId

public String getHoldPatronId()

Returns the patron id of the patron assigned to the hold for the item.

Returns:

id of the patron assigned to the hold for the item

setHoldPatronId

public void setHoldPatronId(String holdPatronId)

Sets the patron id of the patron assigned to the hold for the item.

Parameters:

holdPatronId - patron id

getHoldPatronName

public String getHoldPatronName()

Returns the patron name of the patron assigned to the hold for the item.

Returns:

name of the patron assigned to the hold for the item

setHoldPatronName

public void setHoldPatronName(String holdPatronName)

Sets the patron name of the patron assigned to the hold for the item.

Parameters:

holdPatronName - name of the patron

countChecksum

public String countChecksum()

Counts the chekcsum of this response message.

Specified by:

countChecksum in class SIP2MessageResponse

Returns:

checksum