com.raritantechnologies.quickstart.taglibrary.request
Class RemoveParameterRequestFormatter

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.request.RemoveParameterRequestFormatter

All Implemented Interfaces:

IConfigurable, IRequestFormatter

public class RemoveParameterRequestFormatter

extends java.lang.Object

implements IRequestFormatter

Removes one or more parameters from the current request by creating a request hyperlink that retains all of the current request parameters minus the ones being excluded.

XML Configuration Template:

   <RequestFormatter class="com.raritantechnologies.quickstart.taglibrary.request.RemoveParameterRequestFormatter"
                        action="[ action page ]"
                        label="[ text string to display with the remove link ]"
                        imageURL="[ URL to image to display for the remove link ]" 
                        excludedParams="[ comma separated list of HTTP request parameters to exclude ]"
                        showLabelParams="[ (optional) set of parameters that cause the label to be shown ]" >

     <!-- One or more Fixed Parameters to add to the request -->
     <FixedParam name="[ name of param ]" value="[ parameter value ]" />

   </RequestFormatter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

RemoveParameterRequestFormatter()

Method Summary

java.lang.String	formatSearchRequest(RaritanPageContext pageContext) Reformat the http request as a String.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveParameterRequestFormatter

public RemoveParameterRequestFormatter()

Method Detail

formatSearchRequest

public java.lang.String formatSearchRequest(RaritanPageContext pageContext)

Description copied from interface: IRequestFormatter

Reformat the http request as a String.

Specified by:

formatSearchRequest in interface IRequestFormatter

initialize

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

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IRequestFormatter