com.pkrete.jsip2.messages.requests
Class SIP2SCStatusRequest

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

All Implemented Interfaces:

Serializable

public class SIP2SCStatusRequest
extends SIP2MessageRequest

This class represents the request that sends the current status of the system to the ILS SIP server, which replies with the SIP2ACSStatusResponse message.

Author:

Petteri Kivimäki

See Also:

Serialized Form

Field Summary

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

SIP2SCStatusRequest()
Constructs and initializes a new SIP2SCStatusRequest object.

SIP2SCStatusRequest(StatusCode status)
Constructs and initializes a new SIP2SCStatusRequest object with the given status code.

SIP2SCStatusRequest(StatusCode status, String maxPrintWidth)
Constructs and initializes a new SIP2SCStatusRequest object with the given status code and max print width.

Method Summary

String	getData() Returns a string presentation of the message.
String	getMaxPrintWidth() Returns the maximum number of characters that the system printer can print in one line.
StatusCode	getStatusCode() Returns the status of the system.
void	setMaxPrintWidth(String maxPrintWidth) Changes the maximum number of characters that the system printer can print in one line.
void	setStatusCode(StatusCode statusCode) Changes the status of the system.

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

SIP2SCStatusRequest

public SIP2SCStatusRequest()

Constructs and initializes a new SIP2SCStatusRequest object.

SIP2SCStatusRequest

public SIP2SCStatusRequest(StatusCode status)

Constructs and initializes a new SIP2SCStatusRequest object with the given status code.

Parameters:

status - the status of the system

SIP2SCStatusRequest

public SIP2SCStatusRequest(StatusCode status,
                           String maxPrintWidth)

Constructs and initializes a new SIP2SCStatusRequest object with the given status code and max print width.

Parameters:

status - the status of the system

maxPrintWidth - number of characters the system printer can print on one line

Method Detail

getStatusCode

public StatusCode getStatusCode()

Returns the status of the system.

Returns:

status of the system

setStatusCode

public void setStatusCode(StatusCode statusCode)

Changes the status of the system.

Parameters:

statusCode - new value

getMaxPrintWidth

public String getMaxPrintWidth()

Returns the maximum number of characters that the system printer can print in one line. The value is 3-char, fixed-length.

Returns:

the maxPrintWidth

setMaxPrintWidth

public void setMaxPrintWidth(String maxPrintWidth)

Changes the maximum number of characters that the system printer can print in one line. The value is 3-char, fixed-length.

Parameters:

maxPrintWidth - new value, must be 3-char and fixed-length

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