ORG.oclc.sip
Class Hold

java.lang.Object
  |
  +--ORG.oclc.sip.Hold

public class Hold

extends Object

The Hold is used by the SC to create, Modify, or delete a hold. The ACS should respond with a HoldResponse message. Either or both of the itemIdentifier and titleIdentifier fields must be present for the message to be useful.

15

Field Summary

static String	ADD Add a hold
static String	CHANGE Change a hold
static String	DELETE Delete a hold
static String	NO No, fee not acknowledged
static String	YES Yes, fee acknowledged

Constructor Summary

Hold()
Contructs a new Hold

Hold(String holdMode, String expirationDate, String pickupLocation, String holdType, String institutionId, String patronIdentifier, String patronPassword, String itemIdentifier, String titleIdentifier, String terminalPassword, String feeAcknowledged)
Contructs a new PatronInformation

Method Summary

String	buildMessage() Returns a String containing the Hold message Doesn't use checksums or sequence numbers
String	buildMessage(boolean useChecksums) Returns a String containing the Hold message
String	buildMessage(boolean useChecksums, String seq) Returns a String containing the Hold message
String	toString() Generates the String representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ADD

public static final String ADD

Add a hold

DELETE

public static final String DELETE

Delete a hold

CHANGE

public static final String CHANGE

Change a hold

YES

public static final String YES

Yes, fee acknowledged

NO

public static final String NO

No, fee not acknowledged

Constructor Detail

Hold

public Hold()

Contructs a new Hold

Hold

public Hold(String holdMode,
            String expirationDate,
            String pickupLocation,
            String holdType,
            String institutionId,
            String patronIdentifier,
            String patronPassword,
            String itemIdentifier,
            String titleIdentifier,
            String terminalPassword,
            String feeAcknowledged)

Contructs a new PatronInformation

Parameters:

String - holdMode

String - expirationDate

String - pickupLocation

String - holdType

String - institutionId

String - patronIdentifier

String - patronPassword

String - itemIdentifier

String - titleIdentifier

String - terminalPassword

String - feeAcknowledged

Method Detail

buildMessage

public String buildMessage()

Returns a String containing the Hold message Doesn't use checksums or sequence numbers

Returns:

String the Hold message

buildMessage

public String buildMessage(boolean useChecksums)

Returns a String containing the Hold message

Parameters:

useChecksums - boolean indicating whether to include checksums

Returns:

String the Hold message

buildMessage

public String buildMessage(boolean useChecksums,
                           String seq)

Returns a String containing the Hold message

Parameters:

useChecksums - boolean indicating whether to include checksums

seq - String containing the sequence number to include ("0" to "9"). If not included or wrong length, uses "0".

Returns:

String the Hold message

toString

public final String toString()

Generates the String representation of the object.

Returns:

the String representation of the object.

Overrides:

toString in class Object