com.pkrete.jsip2.messages.requests
Class SIP2BlockPatronRequest

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageRequest
          com.pkrete.jsip2.messages.requests.SIP2BlockPatronRequest

All Implemented Interfaces:

Serializable

public class SIP2BlockPatronRequest
extends SIP2MessageRequest

This class represents the message that is used to request the ILS to block the patron card. This is, for example, sent when the patron is detected tampering with the system or when a patron forgets to take their card. The ILS should invalidate the patron's card and respond with a SIP2PatronStatusResponse message. The ILS could also notify the library staff that the card has been blocked.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

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

Method Summary

String	getBlockedCardMsg() Returns the reason why the patron's card was blocked.
String	getData() Returns a string presentation of the message.
boolean	isCardRetained() Returns true if and only if the patron'n library card has been retained by the system.
void	setBlockedCardMsg(String blockedCardMsg) Sets the reason why the patron's card was blocked,
void	setCardRetained(boolean cardRetained) Sets the value that tells if the patron'n library card has been retained by the system.

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

Method Detail

isCardRetained

public boolean isCardRetained()

Returns true if and only if the patron'n library card has been retained by the system.

Returns:

true if the patron'n library card has been retained by the system, otherwise false

setCardRetained

public void setCardRetained(boolean cardRetained)

Sets the value that tells if the patron'n library card has been retained by the system.

Parameters:

cardRetained - true or false

getBlockedCardMsg

public String getBlockedCardMsg()

Returns the reason why the patron's card was blocked.

Returns:

the reason why the patron's card was blocked

setBlockedCardMsg

public void setBlockedCardMsg(String blockedCardMsg)

Sets the reason why the patron's card was blocked,

Parameters:

blockedCardMsg - new reason

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