com.pkrete.jsip2.messages.responses
Class SIP2ACSStatusResponse

java.lang.Object
  com.pkrete.jsip2.messages.SIP2Message
      com.pkrete.jsip2.messages.SIP2MessageResponse
          com.pkrete.jsip2.messages.responses.SIP2ACSStatusResponse

All Implemented Interfaces:

Serializable

public class SIP2ACSStatusResponse
extends SIP2MessageResponse

This class represents the response message that the ILS SIP server must send in response to the SIP2SCStatusRequest message. This messages contains some of the rules to be followed in further communication and establishes some parameters needed as well.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

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

SIP2ACSStatusResponse(String data)
Constructs and initializes a new SIP2ACSStatusResponse object containing the given data.

Method Summary

String	countChecksum() Counts the chekcsum of this response message.
String	getDateTimeSync() Returns the date and time received from the ILS SIP server. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
String	getLibraryName() Returns the library's name.
String	getProtocolVersion() Returns the protocol version that the ILS SIP server is currently using. 4-char, fixed-length field: x.xx.
int	getRetriesAllowed() Returns the number of retries that are allowed for a specific transaction.
SupportedMessages	getSupportedMessages() Returns the informations about the supported messages by the ILS SIP server.
String	getTerminalLocation() Returns the system's location received from the ILS.
int	getTimeoutPeriod() Returns a timeout period until a transaction is aborted.
boolean	isCheckinOk() Returns true if, and only if, the system is allowed to checkin items.
boolean	isCheckoutOk() Returns true if, and only if, the system is allowed to checkout items.
boolean	isILSRenewalPolicy() Returns true if, and only if, the system is allowed to process patrons renewal requests.
boolean	isOfflineOk() Returns true if, and only if, the ILS SIP server supports off-line operation feature.
boolean	isOnLineStatus() Returns true if, and only if, the ILS SIP server is online.
boolean	isStatusUpdateOk() Returns true if, and only if, the system is allowed to update patron status.
void	setCheckinOk(boolean checkinOk) Sets the checkinOk value, that tells if the system is allowed to checkin items.
void	setCheckoutOk(boolean checkoutOk) Sets the checkoutOk value, that tells if the system is allowed to checkout items.
void	setDateTimeSync(String dateTimeSync) Sets the dateTimeSync value, that tells the date and time of the ILS SIP server. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.
void	setILSRenewalPolicy(boolean ILSRenewalPolicy) Sets the ILSRenewalPolicy value, that tells if the system is allowed to process patrons renewal requests.
void	setLibraryName(String libraryName) Sets the libraryName value, that tells the library's name.
void	setOfflineOk(boolean offlineOk) Sets the offlineOk value, that tells if the ILS SIP server supports off-line operation feature.
void	setOnLineStatus(boolean onLineStatus) Sets the online status value of the ILS SIP server.
void	setProtocolVersion(String protocolVersion) Sets the protocolVersion value, that tells the protocol version that the ILS SIP version is currently using. 4-char, fixed-length field: x.xx.
void	setRetriesAllowed(int retriesAllowed) Sets the retriesAllowed value, that tells the number of retries that are allowed for a specific transaction. 999 indicates that the retry number is unknown.
void	setStatusUpdateOk(boolean statusUpdateOk) Sets the statusUpdateOk value, that tells if the system is allowed to update patron status.
void	setSupportedMessages(SupportedMessages supportedMessages) Sets the supportedMessages value, that tells the supported messages by the ILS SIP server.
void	setTerminalLocation(String terminalLocation) Sets the terminalLocation value, that tells system's location received from the ILS.
void	setTimeoutPeriod(int timeoutPeriod) Changes the timeout period until a transaction is aborted.

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

Constructor Detail

SIP2ACSStatusResponse

public SIP2ACSStatusResponse(String data)

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

Parameters:

data - the data that the message contains

Method Detail

isOnLineStatus

public boolean isOnLineStatus()

Returns true if, and only if, the ILS SIP server is online.

Returns:

true if the ILS SIP server is online, otherwise false

setOnLineStatus

public void setOnLineStatus(boolean onLineStatus)

Sets the online status value of the ILS SIP server.

Parameters:

onLineStatus - true or false

isCheckinOk

public boolean isCheckinOk()

Returns true if, and only if, the system is allowed to checkin items.

Returns:

true the system is allowed to checkin item, otherwise false

setCheckinOk

public void setCheckinOk(boolean checkinOk)

Sets the checkinOk value, that tells if the system is allowed to checkin items.

Parameters:

checkinOk - true or false

isCheckoutOk

public boolean isCheckoutOk()

Returns true if, and only if, the system is allowed to checkout items.

Returns:

true if the system is allowed to checkout, otherwise false

setCheckoutOk

public void setCheckoutOk(boolean checkoutOk)

Sets the checkoutOk value, that tells if the system is allowed to checkout items.

Parameters:

checkoutOk - true or false

isILSRenewalPolicy

public boolean isILSRenewalPolicy()

Returns true if, and only if, the system is allowed to process patrons renewal requests.

Returns:

true if the system is allowed to process patrons renewal requests, otherwise false

setILSRenewalPolicy

public void setILSRenewalPolicy(boolean ILSRenewalPolicy)

Sets the ILSRenewalPolicy value, that tells if the system is allowed to process patrons renewal requests.

Parameters:

ILSRenewalPolicy - true or false

isStatusUpdateOk

public boolean isStatusUpdateOk()

Returns true if, and only if, the system is allowed to update patron status.

Returns:

true the system is allowed to update patron status, otherwise false

setStatusUpdateOk

public void setStatusUpdateOk(boolean statusUpdateOk)

Sets the statusUpdateOk value, that tells if the system is allowed to update patron status.

Parameters:

statusUpdateOk - true or false

isOfflineOk

public boolean isOfflineOk()

Returns true if, and only if, the ILS SIP server supports off-line operation feature.

Returns:

true if the ILS SIP server supports off-line operation feature, otherwise false

setOfflineOk

public void setOfflineOk(boolean offlineOk)

Sets the offlineOk value, that tells if the ILS SIP server supports off-line operation feature.

Parameters:

offlineOk - true or false

getTimeoutPeriod

public int getTimeoutPeriod()

Returns a timeout period until a transaction is aborted. The period is a number expressed in tenths of a second. 000 indicates that the ILS is not online. 999 indicates that the time-out is unknown.

Returns:

timeout period expressed in tenths of a second

setTimeoutPeriod

public void setTimeoutPeriod(int timeoutPeriod)

Changes the timeout period until a transaction is aborted. The timeout period is a number expressed in tenths of a second. 000 indicates that the ILS is not online. 999 indicates that the time-out is unknown.

Parameters:

timeoutPeriod - new value expressed in tenths of a second

getRetriesAllowed

public int getRetriesAllowed()

Returns the number of retries that are allowed for a specific transaction.

Returns:

number of retries that are allowed for a specific transaction

setRetriesAllowed

public void setRetriesAllowed(int retriesAllowed)

Sets the retriesAllowed value, that tells the number of retries that are allowed for a specific transaction. 999 indicates that the retry number is unknown.

Parameters:

retriesAllowed - number of retries

getDateTimeSync

public String getDateTimeSync()

Returns the date and time received from the ILS SIP server. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.

Returns:

ILS SIP server date and time, 18-char: YYYYMMDDZZZZHHMMSS

setDateTimeSync

public void setDateTimeSync(String dateTimeSync)

Sets the dateTimeSync value, that tells the date and time of the ILS SIP server. 18-char, fixed-length field: YYYYMMDDZZZZHHMMSS.

Parameters:

dateTimeSync - date and time, 18-char: YYYYMMDDZZZZHHMMSS

getProtocolVersion

public String getProtocolVersion()

Returns the protocol version that the ILS SIP server is currently using. 4-char, fixed-length field: x.xx.

Returns:

protocol version that the ILS SIP server is currently using. 4-char: x.xx.

setProtocolVersion

public void setProtocolVersion(String protocolVersion)

Sets the protocolVersion value, that tells the protocol version that the ILS SIP version is currently using. 4-char, fixed-length field: x.xx.

Parameters:

protocolVersion - the protocol version that the ILS SIP server is currently using. 4-char: x.xx

getLibraryName

public String getLibraryName()

Returns the library's name.

Returns:

library's name

setLibraryName

public void setLibraryName(String libraryName)

Sets the libraryName value, that tells the library's name.

Parameters:

libraryName - library's name

getSupportedMessages

public SupportedMessages getSupportedMessages()

Returns the informations about the supported messages by the ILS SIP server.

Returns:

the supportedMessages supported messages by the ILS SIP server

setSupportedMessages

public void setSupportedMessages(SupportedMessages supportedMessages)

Sets the supportedMessages value, that tells the supported messages by the ILS SIP server.

Parameters:

supportedMessages - supported messages by the ILS SIP server

getTerminalLocation

public String getTerminalLocation()

Returns the system's location received from the ILS.

Returns:

system's location received from the ILS

setTerminalLocation

public void setTerminalLocation(String terminalLocation)

Sets the terminalLocation value, that tells system's location received from the ILS.

Parameters:

terminalLocation - system's location received from the ILS

countChecksum

public String countChecksum()

Counts the chekcsum of this response message.

Specified by:

countChecksum in class SIP2MessageResponse

Returns:

checksum