com.pkrete.jsip2.messages.responses
Class SIP2CheckoutResponse

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageResponse
          com.pkrete.jsip2.messages.responses.SIP2CirculationTransactionResponse
              com.pkrete.jsip2.messages.responses.SIP2CheckoutResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SIP2RenewResponse

public class SIP2CheckoutResponse
extends SIP2CirculationTransactionResponse

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

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

protected boolean	desensitize Tells if the system should desensitize the item.
protected boolean	desensitizeSupported Tells if the ILS recognizes if the item should or should not be desensitized.
protected boolean	renewalOk Tells if the item is already checked out.
protected boolean	securityInhibit Tells if the system should ignore the security status of the item.
protected boolean	securityInhibitUsed Indicates if the securityInhibit value was used in the response received from the ILS SIP server.

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

magneticMedia, magneticMediaSupported

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

	SIP2CheckoutResponse(String data) Constructs and initializes a new SIP2CheckoutResponse object containing the given data.
protected	SIP2CheckoutResponse(String code, String data) Constructs and initializes a new SIP2CheckoutResponse object containing the given data.

Method Summary

String	countChecksum() Counts the chekcsum of this response message.
boolean	isDesensitize() Returns true if and only if the system should desensitize the item.
boolean	isDesensitizeSupported() Returns true if and only if the ILS recognizes that the item should or should not be desensitized.
boolean	isRenewalOk() Returns true if and only if the item is already checked out.
boolean	isSecurityInhibit() Returns true if and only if the system should ignore the security status of the item.
boolean	isSecurityInhibitUsed() Returns true if and only if the securityInhibit field was used in the response message received from the ILS SIP server.
void	setDesensitize(boolean desensitize) Sets the value that tells if the system should desensitize the item.
void	setDesensitizeSupported(boolean desensitizeSupported) Sets the value that tells if the ILS recognizes that the item should or should not be desensitized.
void	setRenewalOk(boolean renewalOk) Changes the value that tells if the item is already checked out.
void	setSecurityInhibit(boolean securityInhibit) Sets the value that tells if the system should ignore the security status of the item.
void	setSecurityInhibitUsed(boolean securityInhibitUsed) Sets the boolean value that tells if the securityInhibit field was used in the response message received from the ILS SIP server.

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

isMagneticMedia, isMagneticMediaSupported, setMagneticMedia, setMagneticMediaSupported

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

Field Detail

renewalOk

protected boolean renewalOk

Tells if the item is already checked out. True means that the item was already checked out to the same patron, so the item is actually being renewed. False means that the patron did not already have the item checked out.

desensitizeSupported

protected boolean desensitizeSupported

Tells if the ILS recognizes if the item should or should not be desensitized. If this value is false, then also desensitize must be false.

desensitize

protected boolean desensitize

Tells if the system should desensitize the item. If the ILS does not know if the item should be desensitized or not, then this value must be false.

securityInhibit

protected boolean securityInhibit

Tells if the system should ignore the security status of the item. Optional field.

securityInhibitUsed

protected boolean securityInhibitUsed

Indicates if the securityInhibit value was used in the response received from the ILS SIP server.

Constructor Detail

SIP2CheckoutResponse

protected SIP2CheckoutResponse(String code,
                               String data)

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

Parameters:

code - command identifier

data - the data that the message contains

SIP2CheckoutResponse

public SIP2CheckoutResponse(String data)

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

Parameters:

data - the data that the message contains

Method Detail

isRenewalOk

public boolean isRenewalOk()

Returns true if and only if the item is already checked out. True means that the item was already checked out to the same patron, so the item is actually being renewed. False means that the patron did not already have the item checked out.

Returns:

true if the item is already checked out, otherwise false

setRenewalOk

public void setRenewalOk(boolean renewalOk)

Changes the value that tells if the item is already checked out.

Parameters:

renewalOk - true or false

isDesensitizeSupported

public boolean isDesensitizeSupported()

Returns true if and only if the ILS recognizes that the item should or should not be desensitized.

Returns:

true if the ILS recognizes that the item should or should not be desensitized, otherwise false

setDesensitizeSupported

public void setDesensitizeSupported(boolean desensitizeSupported)

Sets the value that tells if the ILS recognizes that the item should or should not be desensitized.

Parameters:

desensitizeSupported - true or false

isDesensitize

public boolean isDesensitize()

Returns true if and only if the system should desensitize the item. If the ILS does not know if the item should be desensitized or not, then this value must be false.

Returns:

true if the item should be desensitized, otherwise false

setDesensitize

public void setDesensitize(boolean desensitize)

Sets the value that tells if the system should desensitize the item. If the ILS does not know if the item should be desensitized or not, then this value must be false.

Parameters:

desensitize - true or false

isSecurityInhibit

public boolean isSecurityInhibit()

Returns true if and only if the system should ignore the security status of the item.

Returns:

true if the system should ignore the security status of the item, otherwise false

setSecurityInhibit

public void setSecurityInhibit(boolean securityInhibit)

Sets the value that tells if the system should ignore the security status of the item.

Parameters:

securityInhibit - true or false

isSecurityInhibitUsed

public boolean isSecurityInhibitUsed()

Returns true if and only if the securityInhibit field was used in the response message received from the ILS SIP server.

Returns:

true if the securityInhibit field was used in the response message, otherwise false

setSecurityInhibitUsed

public void setSecurityInhibitUsed(boolean securityInhibitUsed)

Sets the boolean value that tells if the securityInhibit field was used in the response message received from the ILS SIP server.

Parameters:

securityInhibitUsed - true or false

countChecksum

public String countChecksum()

Counts the chekcsum of this response message.

Specified by:

countChecksum in class SIP2MessageResponse

Returns:

checksum