com.pkrete.jsip2.messages.requests
Class SIP2RenewRequest

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageRequest
          com.pkrete.jsip2.messages.requests.SIP2CirculationTransactionRequest
              com.pkrete.jsip2.messages.requests.SIP2RenewRequest

All Implemented Interfaces:

Serializable

public class SIP2RenewRequest
extends SIP2CirculationTransactionRequest

This class represents the message that is used to renew an item. The ILS SIP server should respond with the SIP2RenewResponse message. Either or both the item identifier and title identifier fields must be present for the message to be useful. This class extends the abstract SIP2CirculationTransactionRequest class.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

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

cancel, nbDueDate, noBlock, useCancel

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

SIP2RenewRequest(String patronId)
Constructs and initializes a new SIP2RenewRequest object with the given values.

SIP2RenewRequest(String patronId, String itemId)
Constructs and initializes a new SIP2RenewRequest object with the given values.

SIP2RenewRequest(String patronId, String itemId, String titleId)
Constructs and initializes a new SIP2RenewRequest object with the given values.

SIP2RenewRequest(String institutionId, String patronId, String itemId, String titleId)
Constructs and initializes a new SIP2RenewRequest object with the given values.

Method Summary

String	getData() Returns a string presentation of the message.
boolean	isThirdPartyAllowed() Returns true if and only if third party renewals are allowed.
void	setThirdPartyAllowed(boolean thirdPartyAllowed) Sets the value that tells if third party renewals are allowed.

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

getNbDueDate, isCancel, isNoBlock, isUseCancel, setCancel, setNbDueDate, setNoBlock, setUseCancel

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

SIP2RenewRequest

public SIP2RenewRequest(String patronId)

Constructs and initializes a new SIP2RenewRequest object with the given values.

Parameters:

patronId - an identifying value for the patron

SIP2RenewRequest

public SIP2RenewRequest(String patronId,
                        String itemId)

Constructs and initializes a new SIP2RenewRequest object with the given values.

Parameters:

patronId - an identifying value for the patron

itemId - an identifying value for the item

SIP2RenewRequest

public SIP2RenewRequest(String patronId,
                        String itemId,
                        String titleId)

Constructs and initializes a new SIP2RenewRequest object with the given values.

Parameters:

patronId - an identifying value for the patron

itemId - an identifying value for the item

titleId - an identifying value for the title

SIP2RenewRequest

public SIP2RenewRequest(String institutionId,
                        String patronId,
                        String itemId,
                        String titleId)

Constructs and initializes a new SIP2RenewRequest object with the given values.

Parameters:

institutionId - library's institution id

patronId - an identifying value for the patron

itemId - an identifying value for the item

titleId - an identifying value for the title

Method Detail

isThirdPartyAllowed

public boolean isThirdPartyAllowed()

Returns true if and only if third party renewals are allowed.

Returns:

true if third party renewals are allowed, otherwise false

setThirdPartyAllowed

public void setThirdPartyAllowed(boolean thirdPartyAllowed)

Sets the value that tells if third party renewals are allowed.

Parameters:

thirdPartyAllowed - true or false

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