com.pkrete.jsip2.messages.responses
Class SIP2PatronInformationResponse

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageResponse
          com.pkrete.jsip2.messages.responses.SIP2PatronResponse
              com.pkrete.jsip2.messages.responses.SIP2PatronInformationResponse

All Implemented Interfaces:

Serializable

public class SIP2PatronInformationResponse
extends SIP2PatronResponse

This class represents the response message that the ILS SIP server must send in response to the SIP2PatronInformationRequest message}.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

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

language, personalName, status, validPatron, validPatronPassword, validPatronPasswordUsed, validPatronUsed

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

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

Method Summary

String	countChecksum() Counts the chekcsum of this response message.
String	getBirthDate() Returns the patron's birth date. 6-char, fixed-length field, MMDDYYYY.
int	getChargedItemsCount() Returns the number of charged items for this patron.
int	getChargedItemsLimit() Returns the limit number for charged items for this patron.
String	getEmail() Returns the email address of the patron.
String	getFeeLimit() Returns the limiting value for fines and fees that the patron is allowed to accumulate in his account.
int	getFineItemsCount() Returns the number of fine items for this patron.
int	getHoldItemsCount() Returns the number of hold items for this patron.
int	getHoldItemsLimit() Returns the limit number for hold items for this patron.
String	getHomeAddress() Returns the home address of the patron.
List<String>	getItems() Returns a list of item barcodes of the item type defined in the PatronInformationRequest message.
ItemType	getItemType() Returns the type of the items in the items list.
int	getOverdueItemsCount() Returns the number of overdue items for this patron.
int	getOverdueItemsLimit() Returns the limit number for overdue items for this patron.
String	getPacAccessType() Returns the patron's PAC access level.
String	getPatronGroup() Returns the code of the patron group in which the patron belongs to.
String	getPatronType() Returns the patron's patron type, such as child, juvenile, adult, etc
String	getPhone() Returns the phnoe number of the patron.
int	getRecallItemsCount() Returns the number of recall items for this patron.
int	getUnavailableHoldsCount() Return the number of unavailable holds for this patron.
void	setBirthDate(String birthDate) Sets the patron's birth date.
void	setChargedItemsCount(int chargedItemsCount) Changes the number of charged items for this patron.
void	setChargedItemsLimit(int chargedItemsLimit) Changes the limit number for charged items for this patron.
void	setEmail(String email) Changes the email address of the patron.
void	setFeeLimit(String feeLimit) Changes the limiting value for fines and fees that the patron is allowed to accumulate in his account.
void	setFineItemsCount(int fineItemsCount) Changes the number of fine items for this patron.
void	setHoldItemsCount(int holdItemsCount) Changes the number of hold items for this patron.
void	setHoldItemsLimit(int holdItemsLimit) Changes the limit number for hold items for this patron.
void	setHomeAddress(String homeAddress) Changes the home address of the patron.
void	setItems(List<String> items) Changes the lis of item barcodes of the item type defined in the PatronInformationRequest message
void	setItemType(ItemType itemType) Changes the type of the items in the items list.
void	setOverdueItemsCount(int overdueItemsCount) Changes the number of overdue items for this patron.
void	setOverdueItemsLimit(int overdueItemsLimit) Changes the limit number for overdue items for this patron.
void	setPacAccessType(String pacAccessType) Sets the patron's PAC access level.
void	setPatronGroup(String patronGroup) Changes the code of the patron group in which the patron belongs to.
void	setPatronType(String patronType) Sets the patron's patron type, such as child, juvenile, adult, etc
void	setPhone(String phone) Changes the phone number of the patron.
void	setRecallItemsCount(int recallItemsCount) Changes the number of recall items for this patron.
void	setUnavailableHoldsCount(int unavailableHoldsCount) Changes the number of unavailable holds for this patron.

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

getLanguage, getPersonalName, getStatus, isValidPatron, isValidPatronPassword, isValidPatronPasswordUsed, isValidPatronUsed, setLanguage, setPersonalName, setStatus, setValidPatron, setValidPatronPassword, setValidPatronPasswordUsed, setValidPatronUsed

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

SIP2PatronInformationResponse

public SIP2PatronInformationResponse(String data)

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

Parameters:

data - the data that the message contains

Method Detail

getFeeLimit

public String getFeeLimit()

Returns the limiting value for fines and fees that the patron is allowed to accumulate in his account. It's a money amount in whatever currency type is defined in this message.

Returns:

fee limit

setFeeLimit

public void setFeeLimit(String feeLimit)

Changes the limiting value for fines and fees that the patron is allowed to accumulate in his account. It's a money amount in whatever currency type is defined in this message.

Parameters:

feeLimit - new value

getHoldItemsCount

public int getHoldItemsCount()

Returns the number of hold items for this patron.

Returns:

number of hold items for this patron

setHoldItemsCount

public void setHoldItemsCount(int holdItemsCount)

Changes the number of hold items for this patron.

Parameters:

holdItemsCount - new value

getOverdueItemsCount

public int getOverdueItemsCount()

Returns the number of overdue items for this patron.

Returns:

number of overdue items for this patron

setOverdueItemsCount

public void setOverdueItemsCount(int overdueItemsCount)

Changes the number of overdue items for this patron.

Parameters:

overdueItemsCount - new value

getChargedItemsCount

public int getChargedItemsCount()

Returns the number of charged items for this patron.

Returns:

number of charged items for this patron

setChargedItemsCount

public void setChargedItemsCount(int chargedItemsCount)

Changes the number of charged items for this patron.

Parameters:

chargedItemsCount - new value

getFineItemsCount

public int getFineItemsCount()

Returns the number of fine items for this patron.

Returns:

number of fine items for this patron

setFineItemsCount

public void setFineItemsCount(int fineItemsCount)

Changes the number of fine items for this patron.

Parameters:

fineItemsCount - new value

getRecallItemsCount

public int getRecallItemsCount()

Returns the number of recall items for this patron.

Returns:

number of recall items for this patron

setRecallItemsCount

public void setRecallItemsCount(int recallItemsCount)

Changes the number of recall items for this patron.

Parameters:

recallItemsCount - new value

getUnavailableHoldsCount

public int getUnavailableHoldsCount()

Return the number of unavailable holds for this patron.

Returns:

number of unavailable holds for this patron

setUnavailableHoldsCount

public void setUnavailableHoldsCount(int unavailableHoldsCount)

Changes the number of unavailable holds for this patron.

Parameters:

unavailableHoldsCount - new value

getHoldItemsLimit

public int getHoldItemsLimit()

Returns the limit number for hold items for this patron. If the value is not defined, returns -1. Optional field.

Returns:

limit number for hold items for this patron

setHoldItemsLimit

public void setHoldItemsLimit(int holdItemsLimit)

Changes the limit number for hold items for this patron. Optional field.

Parameters:

holdItemsLimit - new value

getOverdueItemsLimit

public int getOverdueItemsLimit()

Returns the limit number for overdue items for this patron. If the value is not defined, returns -1. Optional field.

Returns:

limit number for overdue items for this patron

setOverdueItemsLimit

public void setOverdueItemsLimit(int overdueItemsLimit)

Changes the limit number for overdue items for this patron. Optional field.

Parameters:

overdueItemsLimit - new value

getChargedItemsLimit

public int getChargedItemsLimit()

Returns the limit number for charged items for this patron. If the value is not defined, returns -1. Optional field.

Returns:

limit number for charged items for this patron

setChargedItemsLimit

public void setChargedItemsLimit(int chargedItemsLimit)

Changes the limit number for charged items for this patron. Optional field.

Parameters:

chargedItemsLimit - new value

getHomeAddress

public String getHomeAddress()

Returns the home address of the patron.

Returns:

home address of the patron

setHomeAddress

public void setHomeAddress(String homeAddress)

Changes the home address of the patron.

Parameters:

homeAddress - new value

getEmail

public String getEmail()

Returns the email address of the patron.

Returns:

email address of the patron

setEmail

public void setEmail(String email)

Changes the email address of the patron.

Parameters:

email - new value

getPhone

public String getPhone()

Returns the phnoe number of the patron.

Returns:

phone number of the patron

setPhone

public void setPhone(String phone)

Changes the phone number of the patron.

Parameters:

phone - new value

getPatronGroup

public String getPatronGroup()

Returns the code of the patron group in which the patron belongs to. This is an extension field and it's not included to the official SIP2 definition.

Returns:

code of the patron group in which the patron belongs to

setPatronGroup

public void setPatronGroup(String patronGroup)

Changes the code of the patron group in which the patron belongs to. This is an extension field and it's not included to the official SIP2 definition.

Parameters:

patronGroup - new value

getItems

public List<String> getItems()

Returns a list of item barcodes of the item type defined in the PatronInformationRequest message. If no item type was defined in the request or the patron doesn't have any items of the defiend type, returns null.

Returns:

list of item barcodes of the defined type or null

setItems

public void setItems(List<String> items)

Changes the lis of item barcodes of the item type defined in the PatronInformationRequest message

Parameters:

items - new value

getItemType

public ItemType getItemType()

Returns the type of the items in the items list. If no item type was defined in the PatronInformationRequest or if the list is empty, returns null.

Returns:

item type of the items in the items list or null

setItemType

public void setItemType(ItemType itemType)

Changes the type of the items in the items list.

Parameters:

itemType - new value

getBirthDate

public String getBirthDate()

Returns the patron's birth date. 6-char, fixed-length field, MMDDYYYY.

Returns:

patron's birth date

setBirthDate

public void setBirthDate(String birthDate)

Sets the patron's birth date.

Parameters:

birthDate - new birth date, 6-char, fixed-length field, MMDDYYYY

getPacAccessType

public String getPacAccessType()

Returns the patron's PAC access level.

Returns:

patron's PAC access level

setPacAccessType

public void setPacAccessType(String pacAccessType)

Sets the patron's PAC access level.

Parameters:

pacAccessType - new level

getPatronType

public String getPatronType()

Returns the patron's patron type, such as child, juvenile, adult, etc

Returns:

patron type

setPatronType

public void setPatronType(String patronType)

Sets the patron's patron type, such as child, juvenile, adult, etc

Parameters:

patronType - new patron type

countChecksum

public String countChecksum()

Counts the chekcsum of this response message.

Specified by:

countChecksum in class SIP2MessageResponse

Returns:

checksum