com.pkrete.jsip2.messages.requests
Class SIP2HoldRequest

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

All Implemented Interfaces:

Serializable

public class SIP2HoldRequest
extends SIP2MessageRequest

This class represents the message that can is used to create, modify, or delete a hold. The ILS should respond with a SIP2HoldResponse message. Either or both of the item identifier and title identifier fields must be present for the message to be useful.

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

SIP2HoldRequest(String patronId)
Constructs and initializes a new SIP2HoldRequest object with the given values.

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

SIP2HoldRequest(String patronId, String itemId, String titleId)
Constructs and initializes a new SIP2HoldRequest object with the given values.

SIP2HoldRequest(String institutionId, String patronId, String itemId, String titleId)
Constructs and initializes a new SIP2HoldRequest object with the given values.

Method Summary

String	getData() Returns a string presentation of the message.
HoldMode	getHoldMode() Returns the type of the hold transaction: create, delete or modify.
HoldType	getHoldType() Returns the type of the hold: other, any copy, specific copy or any copy at a single branch or sublocation.
void	setHoldMode(HoldMode holdMode) Sets the type of the hold transaction: create, delete or modify.
void	setHoldType(HoldType holdType) Sets the type of the hold: other, any copy, specific copy or any copy at a single branch or sublocation.

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

SIP2HoldRequest

public SIP2HoldRequest(String patronId)

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

Parameters:

patronId - an identifying value for the patron

SIP2HoldRequest

public SIP2HoldRequest(String patronId,
                       String itemId)

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

Parameters:

patronId - an identifying value for the patron

itemId - an identifying value for the item

SIP2HoldRequest

public SIP2HoldRequest(String patronId,
                       String itemId,
                       String titleId)

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

Parameters:

patronId - an identifying value for the patron

itemId - an identifying value for the item

titleId - an identifying value for the title

SIP2HoldRequest

public SIP2HoldRequest(String institutionId,
                       String patronId,
                       String itemId,
                       String titleId)

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

Parameters:

institutionId - library's institution id

patronId - an identifying value for the patron

itemId - an identifying value for the item

titleId - an identifying value for the title

Method Detail

getHoldMode

public HoldMode getHoldMode()

Returns the type of the hold transaction: create, delete or modify.

Returns:

type of the hold transaction

setHoldMode

public void setHoldMode(HoldMode holdMode)

Sets the type of the hold transaction: create, delete or modify.

Parameters:

holdMode - new hold mode

getHoldType

public HoldType getHoldType()

Returns the type of the hold: other, any copy, specific copy or any copy at a single branch or sublocation.

Returns:

type of the hold

setHoldType

public void setHoldType(HoldType holdType)

Sets the type of the hold: other, any copy, specific copy or any copy at a single branch or sublocation.

Parameters:

holdType - new hold type

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