com.pkrete.jsip2.messages.requests
Class SIP2CirculationTransactionRequest

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SIP2CheckinRequest, SIP2CheckoutRequest, SIP2RenewRequest

public abstract class SIP2CirculationTransactionRequest
extends SIP2MessageRequest

This abstract class is a base class of the SIP2CheckoutRequest and the SIP2CheckinRequest classes.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

protected boolean	cancel Should be set to true for a checkout command being used to cancel a failed checkin command, or for a checkin command being used to cancel a failed chakout command.
protected String	nbDueDate No block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
protected boolean	noBlock Notifies the ILS SIP server that the item was already checked in or out while while the SIP server wasn't on-line.
protected boolean	useCancel Tells if cancel field show be added to the request, as the field is optional.

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

protected

SIP2CirculationTransactionRequest(String code) Constructs and initializes a new SIP2CirculationTransactionRequestt with the given command code.

Method Summary

String	getNbDueDate() Returns the no block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS
boolean	isCancel() Returns true if and only if the checkout command is used to cancel a failed checkin command.
boolean	isNoBlock() Returns true if and only if the transaction happened when the ILS SIP server was off-line.
boolean	isUseCancel() Returns true if and only if the cancel field should be added to the request.
void	setCancel(boolean cancel) Sets the value that tells if the checkout command is used to cancel a failed checkin command.
void	setNbDueDate(String nbDueDate) Sets the no block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
void	setNoBlock(boolean noBlock) Changes the boolean value that tells if the transaction happened when the ILS SIP server was off-line.
void	setUseCancel(boolean useCancel) Sets the value that tells if the cancel field should be added to the request.

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, getData, 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

Field Detail

noBlock

protected boolean noBlock

Notifies the ILS SIP server that the item was already checked in or out while while the SIP server wasn't on-line. When true the SIP server should not block the transaction, because it has already been executed. The system can perform transactions while the SIP server is off-line. These transactions are stored and will be sent to the SIP server when it comes back on-line.

cancel

protected boolean cancel

Should be set to true for a checkout command being used to cancel a failed checkin command, or for a checkin command being used to cancel a failed chakout command. Should be set to false for all other checkout or checkin commands. Optional field.

useCancel

protected boolean useCancel

Tells if cancel field show be added to the request, as the field is optional.

nbDueDate

protected String nbDueDate

No block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.

Constructor Detail

SIP2CirculationTransactionRequest

protected SIP2CirculationTransactionRequest(String code)

Constructs and initializes a new SIP2CirculationTransactionRequestt with the given command code.

Parameters:

code - command code

Method Detail

isNoBlock

public boolean isNoBlock()

Returns true if and only if the transaction happened when the ILS SIP server was off-line. When true the SIP server should not block the transaction, because it has already been executed.

Returns:

true if the transaction happened when the ILSnSIP server was off-line, otherwise false

setNoBlock

public void setNoBlock(boolean noBlock)

Changes the boolean value that tells if the transaction happened when the ILS SIP server was off-line. When true the SIP server should not block the transaction, because it has already been executed.

Parameters:

noBlock - new value

isCancel

public boolean isCancel()

Returns true if and only if the checkout command is used to cancel a failed checkin command. Otherwise returns false.

Returns:

true if the checkout command is used to cancel a failed checkin command, otherwise false

setCancel

public void setCancel(boolean cancel)

Sets the value that tells if the checkout command is used to cancel a failed checkin command.

Parameters:

cancel - new value

isUseCancel

public boolean isUseCancel()

Returns true if and only if the cancel field should be added to the request. Otherwise returns false.

Returns:

true if the cancel field should be added to the request, otherwise false

setUseCancel

public void setUseCancel(boolean useCancel)

Sets the value that tells if the cancel field should be added to the request.

Parameters:

useCancel - new value

getNbDueDate

public String getNbDueDate()

Returns the no block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS

Returns:

off-line due date

setNbDueDate

public void setNbDueDate(String nbDueDate)

Sets the no block due date items were given during off-line operation. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.

Parameters:

nbDueDate - new due date (18-char, fixed-length field: YYYYMMDDZZZZHHMMSS)