com.pkrete.jsip2.messages.requests
Class SIP2FeePaidRequest

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

All Implemented Interfaces:

Serializable

public class SIP2FeePaidRequest
extends SIP2MessageRequest

This class represents the message that can be used to notify the ILS that a fee has been collected from the patron. The ILS should record this information in its database and respond with a SIP2FeePaidResponse 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

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

SIP2FeePaidRequest(String institutionId, String patronId, String feeAmount)
Constructs and initializes a new SIP2FeePaidRequest object with the given values.

Method Summary

String	getData() Returns a string presentation of the message.
String	getFeeIdentifier() Returns a value that identifies a specific fee, possible together with fee type.
PaymentType	getPaymentType() Returns the type of the payment: cash, VISA or credit card.
void	setFeeIdentifier(String feeIdentifier) Sets the value that identifies a specific fee, possible together with fee type.
void	setPaymentType(PaymentType paymentType) Sets the payment type.

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

SIP2FeePaidRequest

public SIP2FeePaidRequest(String patronId,
                          String feeAmount)

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

Parameters:

patronId - an identifying value for the patron

feeAmount - fee amount that the patron has paid

SIP2FeePaidRequest

public SIP2FeePaidRequest(String institutionId,
                          String patronId,
                          String feeAmount)

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

Parameters:

institutionId - library's institution id

patronId - an identifying value for the patron

feeAmount - fee amount that the patron has paid

Method Detail

getPaymentType

public PaymentType getPaymentType()

Returns the type of the payment: cash, VISA or credit card.

Returns:

type of the payment

setPaymentType

public void setPaymentType(PaymentType paymentType)

Sets the payment type.

Parameters:

paymentType - new payment type

getFeeIdentifier

public String getFeeIdentifier()

Returns a value that identifies a specific fee, possible together with fee type.

Returns:

value that identifies a specific fee

setFeeIdentifier

public void setFeeIdentifier(String feeIdentifier)

Sets the value that identifies a specific fee, possible together with fee type.

Parameters:

feeIdentifier - new identifier

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