com.raritantechnologies.searchApp.alert
Class AlertListSearchElementRenderer

java.lang.Object
  com.raritantechnologies.searchApp.query.taglibrary.ReadQueriesSearchElementRenderer
      com.raritantechnologies.searchApp.alert.AlertListSearchElementRenderer

All Implemented Interfaces:

IConfigurable, ISearchElementRenderer

public class AlertListSearchElementRenderer

extends ReadQueriesSearchElementRenderer

Renders a set of Queries as Alerts with checkboxes to toggle alert status on/off.

XML Configuration Template:

  <SearchElementRenderer 
     rendererClass="com.raritantechnologies.searchApp.alert.AlertListSearchElementRenderer"
     applicationName="[The application name - needed if mixed schema in persistant store]"
     queryReader="[name of query reader system object (alternate to QueryReader tag)]"
     sortBy="NAME|QUERIES|DATE|RESULTS|TIME"
     sortDir="asc|desc"
     externalSearchForm="[alternate search form to execute]"

     queryWriter="[name of Query Writer system object to update alert status..]"
     checkboxPos="left|right"
     width="width" >
     <!-- QueryWriter must include an "IS_ALERT" field -->

    <QueryReader class="[Implementation class of IQueryResultSetReader]" >
      <!-- Parameters needed by QueryReader class -->
      <!-- NOTE: this should include the "IS_ALERT" parameter -->
    </QueryReader>

    <!-- parameters to be inserted into the SearchForm Page Context -->
    <SearchParams>
      <Param ID="[a request param ID]" />
      <Param ID="[another param ID]" />
    </SearchParams>

  </SearchElementRenderer>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static java.lang.String

IS_ALERT

Fields inherited from class com.raritantechnologies.searchApp.query.taglibrary.ReadQueriesSearchElementRenderer

action, clazz, deSelectedQParam, qSourcesParam, selectedQParam

Constructor Summary

AlertListSearchElementRenderer()

Method Summary

java.lang.String	getBody(ISearchFormRenderer parent, RaritanPageContext pageContext) Returns the element html fragment.
void	initialize(org.w3c.dom.Element elem) Initialize renderer-specific parameters from the configuration XML tag.
protected java.lang.String	processResults(ISearchFormRenderer parent, java.util.Iterator it, RaritanPageContext pageContext)

Methods inherited from class com.raritantechnologies.searchApp.query.taglibrary.ReadQueriesSearchElementRenderer

getHttpQuery, getQueryResultSetReader, getRenderer, isHidden, setEnable

Methods inherited from class java.lang.Object

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

Field Detail

IS_ALERT

public static final java.lang.String IS_ALERT

See Also:

Constant Field Values

Constructor Detail

AlertListSearchElementRenderer

public AlertListSearchElementRenderer()

Method Detail

getBody

public java.lang.String getBody(ISearchFormRenderer parent,
                                RaritanPageContext pageContext)

Description copied from interface: ISearchElementRenderer

Returns the element html fragment.

Specified by:

getBody in interface ISearchElementRenderer

Overrides:

getBody in class ReadQueriesSearchElementRenderer

processResults

protected java.lang.String processResults(ISearchFormRenderer parent,
                                          java.util.Iterator it,
                                          RaritanPageContext pageContext)

Overrides:

processResults in class ReadQueriesSearchElementRenderer

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: ISearchElementRenderer

Initialize renderer-specific parameters from the configuration XML tag.

Specified by:

initialize in interface ISearchElementRenderer

Overrides:

initialize in class ReadQueriesSearchElementRenderer