com.raritantechnologies.prefs.taglibrary
Class SavePreferencesSearchFormRenderer

java.lang.Object
  extended bycom.raritantechnologies.searchApp.taglibrary.BasicSearchFormRenderer
      extended bycom.raritantechnologies.searchApp.taglibrary.SaveResultsSearchFormRenderer
          extended bycom.raritantechnologies.prefs.taglibrary.SavePreferencesSearchFormRenderer
All Implemented Interfaces:
IConfigurable, ISearchFormRenderer

public class SavePreferencesSearchFormRenderer
extends SaveResultsSearchFormRenderer

SearchFormRenderer wrapper that saves form data to a user preferences database.

XML Configuration Template:
 <SearchForm rendererClass="com.raritantechnologies.searchApp.taglibrary.SaveResultsSearchFormRenderer"
                formType="[ form type parameter for save results requests ]"
                cacheResultSetName="[ name of cacheResultSet ]" >

   <UserInfoMap>
      <Field ID="[ Field ID ]"  userAttribute="[ userAttribute Name ]" />
   </UserInfoMap>

   <SaveFormFields 
           userID="[ name of result field that gets UserID ]"
           timeStamp="[ name of result field that gets save time stamp ]" >
           dateFormat="MM/dd/yy"
           cacheFormFields="[true|false(default)]" >

     <Field ID="[ field id in form ]" resultID="[ field ID in result ]" />

     <GatewayOutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]" >

     </GatewayOutputProcessor>

     <ResultSetProcessor class="[ class of com.raritantechnologies.searchApp.IResultSetProcessor ]" >

     </ResultSetProcessor>
   </SaveFormFields>

   <SearchFormRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.ISearchFormRenderer" >

   </SearchFormRenderer>

 </SearchForm>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from class com.raritantechnologies.searchApp.taglibrary.SaveResultsSearchFormRenderer
cacheFormFields, clearAfterSave
 
Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchFormRenderer
action, afterFormData, category, displayStyle, formInitArgs, formMethod, formName, formType, hiddenFieldMap, hiddenFields, includeResetButton, includeSearchForm, includeSubmitButton, initialFields, onSubmitHandler, operatorMap, scriptMap, sourceMapName, submitButtonOnBottom, submitButtonText, submitHandlerName, targetFrame
 
Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.ISearchFormRenderer
CLEAR, PAGE, PAGE_NUM, PAGE_SIZE, RESET, SEARCH
 
Constructor Summary
SavePreferencesSearchFormRenderer()
           
 
Method Summary
 void initialize(org.w3c.dom.Element elem)
          Adds configurable properties to the renderer.
protected  void saveResults(IResultSet resSet, ILoginInfo userInfo, IGatewayOutputProcessor outputProcessor)
           
protected  void saveResults(IResultSet resSet, ILoginInfo userInfo, IResultSetProcessor resSetProcessor)
           
 
Methods inherited from class com.raritantechnologies.searchApp.taglibrary.SaveResultsSearchFormRenderer
getBody
 
Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchFormRenderer
addAfterFormData, addFormScript, addHiddenField, addHiddenFields, addPersistentFields, canUpdateSearchParams, getActionURL, getCategory, getFormInitArgs, getFormMethod, getFormName, getFormStart, getFormType, getHiddenFields, getInitialFields, getOnSubmitHandler, getSubmitHandlerName, renderHiddenFields, renderScripts, setFormMethod, setFormName, setFormType, setOnSubmitHandler, setSubmitHandlerName, updateSearchParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SavePreferencesSearchFormRenderer

public SavePreferencesSearchFormRenderer()
Method Detail

saveResults

protected void saveResults(IResultSet resSet,
                           ILoginInfo userInfo,
                           IResultSetProcessor resSetProcessor)
Overrides:
saveResults in class SaveResultsSearchFormRenderer

saveResults

protected void saveResults(IResultSet resSet,
                           ILoginInfo userInfo,
                           IGatewayOutputProcessor outputProcessor)
Overrides:
saveResults in class SaveResultsSearchFormRenderer

initialize

public void initialize(org.w3c.dom.Element elem)
Description copied from class: BasicSearchFormRenderer
Adds configurable properties to the renderer.

Specified by:
initialize in interface ISearchFormRenderer
Overrides:
initialize in class SaveResultsSearchFormRenderer