ORG.oclc.gadgets
Class RecordHoldings

java.lang.Object
  |
  +--ORG.oclc.gadgets.FormatRecords
        |
        +--ORG.oclc.gadgets.RecordHoldings

public class RecordHoldings

extends FormatRecords

The RecordHoldings class is a gadget that creates an HTML string containing formatted record holdings from a holdings database search for an input citation record. It uses the parameters contained in a RequestManager object and the parameters for the gadget read from the configuration files to build the appropriate output. If an error occurs, an empty string("") is returned.

This class should be treated as an Example of how local holdings can be retrieved for a citation. A QUERY is issued to the holdings database associated with the database defined in the configuration variable HoldingsDbName. The parameters for the search are the citation ISSN and optionally a city and state holding the item. For customization, these parameters should be refined to your site's specifications.

The parameters to the gadget are:
fmt - the name of the formatting class in the holdings database to use such as 'holdings'. This is specified in the [Formats] section of the holdings database configuration file.
norecordsmessage - text to display when there are no holdings records found where the default is an empty string("").
state - the limiting state for the holdings query
city - the limiting city for the holdings query
numrecs - the number of holdings records to retrieve

The holdings database query is set up as a 'temporary' database search so that the user's current state is preserved. The record formatting is performed by the parent class FormatRecords.

See Also:

UserStateObject, WebZFormatter, FormatRecords

Fields inherited from class ORG.oclc.gadgets.FormatRecords

dataWrappers, dbname, displayGadget, errormsg, fmtName, gadgetInfo, initted, numHoldings, recno, recordData, recordformat, resultset, returnedRecs, searchKeyFmt, user, zDb, zUserData

Constructor Summary

RecordHoldings()
Constructs a RecordHoldings object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the holdings records associated with the input citation using the parameters containined in the RequestManager object and the name of the gadget.
String	toString() Generates a String representation of the object.

Methods inherited from class ORG.oclc.gadgets.FormatRecords

formatPresentData, getDataWrappers, init, runFormat, runFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordHoldings

public RecordHoldings()

Constructs a RecordHoldings object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the holdings records associated with the input citation using the parameters containined in the RequestManager object and the name of the gadget.

Parameters:

rMngr - object containing input parameters for the request.

name - the name of the gadget - the section name in the configuration file defining the particular gadget.

Returns:

String

Overrides:

buildit in class FormatRecords

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class FormatRecords