ORG.oclc.gadgets
Class BookMarkEmail

java.lang.Object
  |
  +--ORG.oclc.gadgets.FormatRecords
        |
        +--ORG.oclc.gadgets.BookMarkBrief
              |
              +--ORG.oclc.gadgets.BookMarkEmail

public class BookMarkEmail

extends BookMarkBrief

The BookMarkEmail class is a gadget creates the HTML checkbox string for the e-mail display of bookmarked records. 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.

The parameters to the gadget are:
fmtclass - the name of the formatting class to use such as 'bookmarkbrief'. This is specified in the [Formats] section of the individual database configuration file.

BookMarkEmail retrieves the BookMarkEntry objects saved in the user state object to create the HTML output. Each bookmarked record has been written to the user's temp directory. Each raw record is read from disk and is formatted using the formatting class specified in the gadget and a checkbox for selection is added to the record display.

See Also:

UserStateObject, WebZFormatter, FormatRecords, BookMarkEntry

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

BookMarkEmail()
Constructs a BookMarkEmail object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the e-mail bookmark records 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.BookMarkBrief

getFormattedBookMark

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

BookMarkEmail

public BookMarkEmail()

Constructs a BookMarkEmail object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the e-mail bookmark records 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 BookMarkBrief

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class BookMarkBrief