com.pkrete.jsip2.messages.requests
Class SIP2PatronInformationRequest

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageRequest
          com.pkrete.jsip2.messages.requests.SIP2PatronRequest
              com.pkrete.jsip2.messages.requests.SIP2PatronInformationRequest

All Implemented Interfaces:

Serializable

public class SIP2PatronInformationRequest
extends SIP2PatronRequest

This class represents the message that is used to request detailedd patron information from the ILS SIP server, and this class extends the SIP2PatronRequest message. The ILS SIP server should respond to this message with the SIP2PatronInformationResponse message,

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

Fields inherited from class com.pkrete.jsip2.messages.requests.SIP2PatronRequest

language

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

Constructor Summary

SIP2PatronInformationRequest(String patronIdentifier)
Constructs and initializes a new PatronInformationRequest message with the given parameters.

SIP2PatronInformationRequest(String institutionId, String patronIdentifier)
Constructs and initializes a new PatronInformationRequest message with the given parameters.

SIP2PatronInformationRequest(String institutionId, String patronIdentifier, String patronPassword)
Constructs and initializes a new PatronInformationRequest message with the given parameters.

SIP2PatronInformationRequest(String institutionId, String terminalPassword, String patronIdentifier, String patronPassword)
Constructs and initializes a new PatronInformationRequest message with the given parameters.

Method Summary

String	getData() Returns a string presentation of the message.
String	getEndItem() Returns the number of the last item to be sent in the list defined by the summary.
String	getStartItem() Returns the number of the first item to be sent in the list defined by the summary.
Summary	getSummary() Returns what detailed and summary information of selected category of items that are be requested as a part of this request.
void	setEndItem(String endItem) Sets the number of the last item to be sent in the list defined by the summary.
void	setStartItem(String startItem) Sets the number of the first item to be sent in the list defined by the summary.
void	setSummary(Summary summary) Sets what detailed and summary information of selected category of items that are be requested as a part of this request.

Methods inherited from class com.pkrete.jsip2.messages.requests.SIP2PatronRequest

getLanguage, setLanguage

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

Constructor Detail

SIP2PatronInformationRequest

public SIP2PatronInformationRequest(String patronIdentifier)

Constructs and initializes a new PatronInformationRequest message with the given parameters. The language is set to UNKNOWN by default. No summary information is requested by default.

Parameters:

patronIdentifier - an identifying value for the patron

SIP2PatronInformationRequest

public SIP2PatronInformationRequest(String institutionId,
                                    String patronIdentifier)

Constructs and initializes a new PatronInformationRequest message with the given parameters. The language is set to UNKNOWN by default. No summary information is requested by default.

Parameters:

institutionId - library's institution id

patronIdentifier - an identifying value for the patron

SIP2PatronInformationRequest

public SIP2PatronInformationRequest(String institutionId,
                                    String patronIdentifier,
                                    String patronPassword)

Constructs and initializes a new PatronInformationRequest message with the given parameters. The language is set to UNKNOWN by default. No summary information is requested by default.

Parameters:

institutionId - library's institution id

patronIdentifier - an identifying value for the patron

patronPassword - password (PIN) of the patron

SIP2PatronInformationRequest

public SIP2PatronInformationRequest(String institutionId,
                                    String terminalPassword,
                                    String patronIdentifier,
                                    String patronPassword)

Constructs and initializes a new PatronInformationRequest message with the given parameters. The language is set to UNKNOWN by default. No summary information is requested by default.

Parameters:

institutionId - library's institution id

terminalPassword - password to login the ILS

patronIdentifier - an identifying value for the patron

patronPassword - password (PIN) of the patron

Method Detail

getSummary

public Summary getSummary()

Returns what detailed and summary information of selected category of items that are be requested as a part of this request. For example a list of items that the patron has borrowed.

Returns:

summary object

setSummary

public void setSummary(Summary summary)

Sets what detailed and summary information of selected category of items that are be requested as a part of this request. For example a list of items that the patron has borrowed.

Parameters:

summary - new value

getStartItem

public String getStartItem()

Returns the number of the first item to be sent in the list defined by the summary.

Returns:

the number of the first item to be sent in the list defined by the summary

setStartItem

public void setStartItem(String startItem)

Sets the number of the first item to be sent in the list defined by the summary.

Parameters:

startItem - new value, must contain only numbers

getEndItem

public String getEndItem()

Returns the number of the last item to be sent in the list defined by the summary.

Returns:

the number of the last item to be sent in the list defined by the summary

setEndItem

public void setEndItem(String endItem)

Sets the number of the last item to be sent in the list defined by the summary.

Parameters:

endItem - new value, must contain only numbers

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