Open SiteSearch 4.1.1
Final

ORG.oclc.gadgets
Class QuickSearchTopics

java.lang.Object
  |
  +--ORG.oclc.gadgets.QuickSearchTopics

public class QuickSearchTopics
extends Object
implements GadgetBuilder

The QuickSearchTopics class is a gadget that builds an HTML String containing a set of check boxes for the Quick Search topics found on the database selection page of the SiteSearch OBI. 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:
topicnames - the list of topic names to include in the check box list where the default is 'Articles Books Web'.

For efficiency purposes, the check box string is generated one time and is stored with the user. Any subsequest requests for the data are simply retrievals of the pre-built string.


Constructor Summary
QuickSearchTopics()
          Constructs a QuickSearchTopics object.
 
Method Summary
 String buildit(RequestManager rMngr, String name)
          Generates a String containing the HTML for the quick search topic name check boxes 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QuickSearchTopics

public QuickSearchTopics()
Constructs a QuickSearchTopics object.
Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)
Generates a String containing the HTML for the quick search topic name check boxes using the parameters containined in the RequestManager object and the name of the gadget.
Specified by:
buildit in interface GadgetBuilder
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

toString

public String toString()
Generates a String representation of the object.
Specified by:
toString in interface GadgetBuilder
Returns:
String
Overrides:
toString in class Object

Open SiteSearch 4.1.1
Final