|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.search.adapter.customization.CustomizationDataAdapterImpl atg.commerce.search.refinement.admin.RefineConfigAdapter
public class RefineConfigAdapter
Search customization adapter for commerce refinements. Called by a search admin indexing job to provide refine-config xml for the catalog facets.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
RefineConfigAdapter()
Constructs an instanceof RefineConfigAdapter |
Method Summary | |
---|---|
void |
doStartService()
start the service, verify that required properties are set |
java.util.List |
enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType,
java.lang.String pProjectId)
This method will enumerate all refineConfig items that are to be auto-applied. |
java.util.List |
enumerateCustomizationItems()
return list of refine config ids |
java.util.List |
enumerateCustomizationItemsByType(atg.search.adapter.customization.CustomizationType pCustomizationType)
If the pCustomizationType parameter matches CustomizationType.REFINEMENT_CONFIGURATION, then this will return the same List of refine config ids as the enumerateCustomizationItems() method above. |
atg.search.adapter.customization.CustomizationItem |
getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType,
java.lang.String pCustomizationItemId)
Checks the pCustomizationType parameter. |
java.lang.String |
getDisplayName()
get DisplayName |
RefinementConfigurationGenerator |
getRefinementConfigurationGenerator()
get RefinementConfigurationGenerator |
java.util.Collection |
getSupportedCustomizationTypes()
get a list of supported customization types |
boolean |
isAutoApplyAll()
auto apply all should always be true |
void |
setDisplayName(java.lang.String pDisplayName)
set DisplayName |
void |
setRefinementConfigurationGenerator(RefinementConfigurationGenerator pRefinementConfigurationGenerator)
set RefinementConfigurationGenerator |
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 |
Methods inherited from interface atg.naming.NameContextElement |
---|
getName, getNameContext |
Methods inherited from interface atg.naming.NameContextBindingListener |
---|
nameContextElementBound, nameContextElementUnbound |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public RefineConfigAdapter()
Method Detail |
---|
public void setDisplayName(java.lang.String pDisplayName)
pDisplayName
- the DisplayNamepublic java.lang.String getDisplayName()
getDisplayName
in interface atg.search.adapter.customization.CustomizationDataAdapter
getDisplayName
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public void setRefinementConfigurationGenerator(RefinementConfigurationGenerator pRefinementConfigurationGenerator)
pRefinementConfigurationGenerator
- the RefinementConfigurationGeneratorpublic RefinementConfigurationGenerator getRefinementConfigurationGenerator()
public void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic java.util.List enumerateCustomizationItems()
enumerateCustomizationItems
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateCustomizationItems
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public java.util.List enumerateCustomizationItemsByType(atg.search.adapter.customization.CustomizationType pCustomizationType)
enumerateCustomizationItemsByType
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateCustomizationItemsByType
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
pCustomizationType
- the customization type, must be of type
REFINEMENT_CONFIGURATION or else an empty list is returned
public java.util.List enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pProjectId) throws atg.search.adapter.exception.CustomizationItemNotFoundException
enumerateAutoApplyCustomizationItemsByTypeAndProject
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateAutoApplyCustomizationItemsByTypeAndProject
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
pCustomizationType
- the customization typepProjectId
- the search project id
atg.search.adapter.exception.CustomizationItemNotFoundException
- if there was an error getting the refine configspublic atg.search.adapter.customization.CustomizationItem getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pCustomizationItemId) throws atg.search.adapter.exception.CustomizationItemNotFoundException
getCustomizationItem
in interface atg.search.adapter.customization.CustomizationDataAdapter
getCustomizationItem
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
pCustomizationType
- the typepCustomizationItemId
- the item id
CustomizationItemNotFoundExcpetion
- if there was an error getting the item
atg.search.adapter.exception.CustomizationItemNotFoundException
public java.util.Collection getSupportedCustomizationTypes()
getSupportedCustomizationTypes
in interface atg.search.adapter.customization.CustomizationDataAdapter
getSupportedCustomizationTypes
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public boolean isAutoApplyAll()
isAutoApplyAll
in interface atg.search.adapter.customization.CustomizationDataAdapter
isAutoApplyAll
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |