atg.projects.b2cstore
Class PartsFilterFormHandler

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.droplet.EmptyFormHandler
              extended by atg.droplet.GenericFormHandler
                  extended by atg.targeting.FilterFormHandler
                      extended by atg.projects.b2cstore.PartsFilterFormHandler
All Implemented Interfaces:
DropletFormHandler, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class PartsFilterFormHandler
extends FilterFormHandler

This form handler uses form input to generate an SGML targeting rule that targets parts in a repository.


Field Summary
static java.lang.String CLASS_VERSION
           
static java.lang.String PRICE_ALL
           
static java.lang.String PRICE_CATEGORY
           
 
Fields inherited from class atg.targeting.FilterFormHandler
RESOURCE_BUNDLE
 
Fields inherited from class atg.droplet.GenericFormHandler
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
 
Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY
 
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
DEFAULT_LOG_TRACE_STATUS
 
Fields inherited from interface atg.nucleus.logging.ApplicationLogging
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
 
Constructor Summary
PartsFilterFormHandler()
           
 
Method Summary
protected  java.lang.String getFrameRule()
          Generate a rule to filter on frame type.
 java.lang.String getFrameType()
           
protected  java.lang.String getManufacturerRule()
          Optionally generate a rule to filter on manufacturer
 java.lang.String[] getManufacturers()
           
 java.lang.String getPriceCategory()
           
protected  java.lang.String getPriceRule()
          Optionally generate Price Category rule Price Category:
 java.lang.String getPriceSelectionType()
           
 java.lang.String getRuleRepresentation()
          Generate the SGML Targeting rule to be used in the filter
 boolean getSearchAllManufacturers()
           
 boolean isAnyFrame()
           
 void setAnyFrame(boolean pBool)
           
 void setFrameType(java.lang.String pFrame)
           
 void setManufacturers(java.lang.String[] pManufacturers)
           
 void setPriceCategory(java.lang.String pPriceCategory)
          Price category from product catalog
 void setPriceSelectionType(java.lang.String pPriceType)
           
 void setSearchAllManufacturers(boolean pBool)
           
 
Methods inherited from class atg.targeting.FilterFormHandler
getItemDescriptor, getLoggingIdentifier, getRepository, getRepositoryItemGroup, handleSubmit, setItemDescriptor, setLoggingIdentifier, setRepository, setRepositoryItemGroup, setRuleRepresentation
 
Methods inherited from class atg.droplet.GenericFormHandler
addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards
 
Methods inherited from class atg.droplet.EmptyFormHandler
afterGet, beforeGet
 
Methods inherited from class atg.nucleus.GenericService
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
 
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

PRICE_ALL

public static final java.lang.String PRICE_ALL
See Also:
Constant Field Values

PRICE_CATEGORY

public static final java.lang.String PRICE_CATEGORY
See Also:
Constant Field Values
Constructor Detail

PartsFilterFormHandler

public PartsFilterFormHandler()
Method Detail

setSearchAllManufacturers

public void setSearchAllManufacturers(boolean pBool)
Parameters:
pBool - true to search all manufacturers, false to search from list of manufacturers in property 'manufacturers'

getSearchAllManufacturers

public boolean getSearchAllManufacturers()
Returns:
true to search all manufacturers, false otherwise

setManufacturers

public void setManufacturers(java.lang.String[] pManufacturers)
Parameters:
pManufacturers - zero or more manufacturer names on which to filter

getManufacturers

public java.lang.String[] getManufacturers()
Returns:
null or a list of manufacturers on which to filter

setPriceSelectionType

public void setPriceSelectionType(java.lang.String pPriceType)
Parameters:
pPriceType - one PRICE_ALL | PRICE_CATEGORY

getPriceSelectionType

public java.lang.String getPriceSelectionType()
Returns:
PRICE_ALL | PRICE_CATEGORY

setPriceCategory

public void setPriceCategory(java.lang.String pPriceCategory)
Price category from product catalog


getPriceCategory

public java.lang.String getPriceCategory()

setAnyFrame

public void setAnyFrame(boolean pBool)
Parameters:
true - to search all frame types, false to search from list in property frameType

isAnyFrame

public boolean isAnyFrame()
Returns:
true to ignore frameType, false to filter on frame type

setFrameType

public void setFrameType(java.lang.String pFrame)

getFrameType

public java.lang.String getFrameType()

getRuleRepresentation

public java.lang.String getRuleRepresentation()
Generate the SGML Targeting rule to be used in the filter

Overrides:
getRuleRepresentation in class FilterFormHandler
Returns:
a String containing the SGML targeting rule

getManufacturerRule

protected java.lang.String getManufacturerRule()
Optionally generate a rule to filter on manufacturer

Returns:
A manufacturer rule or empty string

getFrameRule

protected java.lang.String getFrameRule()
Generate a rule to filter on frame type.

Returns:
A frame type rule or empty string

getPriceRule

protected java.lang.String getPriceRule()
Optionally generate Price Category rule Price Category:

Returns:
a price filter rule or empty string