public class Configuration
extends atg.nucleus.GenericService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected java.lang.String[] |
mAlternateResultContentItemTypes |
protected java.lang.Integer |
mAutoSuggestMinLength |
protected java.lang.String |
mAutoSuggestURI |
protected java.lang.String |
mBreadcrumbContentItemType |
protected java.util.Map |
mCatalogRootCategoryMap |
protected java.util.Map<java.lang.String,java.lang.String> |
mCollectionPropertyNames |
protected atg.web.PageFragment |
mDefaultObjectRenderingPageFragment |
protected atg.web.PageFragment |
mDefaultResultContentItemPageFragment |
protected java.util.Map |
mEndecaResourcedValuePropertyNames |
protected java.lang.String |
mEndecaResourcedValuesResourceBundle |
protected atg.nucleus.ServiceMap |
mObjectRenderingPageFragmentsByType |
protected java.lang.String |
mRecordProductIdPropertyName |
protected java.lang.String |
mRecordTypePropertyName |
protected java.lang.String |
mRefinementMenuContentItemType |
protected atg.nucleus.ServiceMap |
mResultContentItemPageFragments |
protected java.util.Map |
mResultContentItemTitleLookupKeys |
protected java.util.Map |
mResultContentItemTitlePropertyNames |
protected java.lang.String |
mResultsListContentItemType |
protected boolean |
mShowRawEndecaResourcedValues |
Constructor and Description |
---|
Configuration() |
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getAlternateResultContentItemTypes()
A list of content item types that contain Endeca records that,
if located in the results,
will be displayed in the UI just above the traditional results list.
|
java.lang.Integer |
getAutoSuggestMinLength()
The number of letters to enter before checking for suggested completions.
|
java.lang.String |
getAutoSuggestURI()
The URI for endeca auto suggest panels.
|
java.lang.String |
getBreadcrumbContentItemType()
Returns the content item type used for the breadcrumb content item.
|
java.util.Map |
getCatalogRootCategoryMap() |
java.util.Map<java.lang.String,java.lang.String> |
getCollectionPropertyNames()
This property identifies which property name on the content item contains
the collection for display for both the alternate content item types
that the use the defaultAlternateResultsPageFragment and the
generic ResultList content item.
|
java.lang.String |
getDefaultContentURI()
The default content URI is expected to be the "root" content URI,
meaning it sets the navigation state to the starting location.
|
atg.web.PageFragment |
getDefaultObjectRenderingPageFragment()
This property identifies the page fragment used to render an object
from a Collection on an alternate result content item and the generic
ResultList content item.
|
atg.web.PageFragment |
getDefaultResultContentItemPageFragment()
The PageFragment that is used by default when rendering result content items.
|
java.util.Map |
getEndecaResourcedValuePropertyNames()
Maps a content item property name to an identifer
for each Endeca supplied resource value used in the UI.
|
java.lang.String |
getEndecaResourcedValuesResourceBundle()
Defines the resource bundle name used to look up resources
when
showRawEndecaResourcedValues is configured
to false |
java.lang.String |
getNavigationFiltersParameterName()
Returns the parameter name used to specific Endeca naviation filter values
on the search request URL.
|
atg.nucleus.ServiceMap |
getObjectRenderingPageFragmentsByType()
Maps result object types to a page fragment used to render the object in the display.
|
java.lang.String |
getRecordOffsetPlaceHolderValue()
Returns the value in the paging template navigation state that is the placeholder for substituting
the record offset value for a paging request.
|
java.lang.String |
getRecordProductIdPropertyName()
Specifies the key in the record attribute map that
references the product id.
|
java.lang.String |
getRecordsPerPagePlaceHolderValue()
Returns the value in the paging template navigation state that is the placeholder for substituting
the records per page value.
|
java.lang.String |
getRecordTypePropertyName()
Returns the key on the record's attributes Map where the type value
is stored.
|
java.lang.String |
getRefinementMenuContentItemType()
Returns the content item type used for the refinement menu content item.
|
atg.nucleus.ServiceMap |
getResultContentItemPageFragments()
A map of PageFragement components keyed by
content item type.
|
java.util.Map |
getResultContentItemTitleLookupKeys()
Maps the key used to locate the property name on each result content item type
that contains the title for display.
|
java.util.Map |
getResultContentItemTitlePropertyNames()
Defines the ContentItem property names that contain the title value.
|
java.lang.String |
getResultsListContentItemType()
Returns the content item type used for the result list content item.
|
boolean |
isShowRawEndecaResourcedValues()
When true, the value of the endeca resourced property
is displayed in its raw form.
|
void |
setAlternateResultContentItemTypes(java.lang.String[] pAlternateResultContentItemTypes) |
void |
setAutoSuggestMinLength(java.lang.Integer pAutoSuggestMinLength)
The number of letters to enter before checking for suggested completions.
|
void |
setAutoSuggestURI(java.lang.String pAutoSuggestURI)
The URI for endeca auto suggest panels.
|
void |
setBreadcrumbContentItemType(java.lang.String pBreadcrumbContentItemType) |
void |
setCatalogRootCategoryMap(java.util.Map pCatalogRootCategoryMap) |
void |
setCollectionPropertyNames(java.util.Map<java.lang.String,java.lang.String> pCollectionPropertyName) |
void |
setDefaultContentURI(java.lang.String pDefaultContentURI)
The default content URI is expected to be the "root" content URI,
meaning it sets the navigation state to the starting location.
|
void |
setDefaultObjectRenderingPageFragment(atg.web.PageFragment pDefaultRecordRenderingPageFragment) |
void |
setDefaultResultContentItemPageFragment(atg.web.PageFragment pDefaultResultContentItemPageFragment) |
void |
setEndecaResourcedValuePropertyNames(java.util.Map pEndecaResourcedValuePropertyNames) |
void |
setEndecaResourcedValuesResourceBundle(java.lang.String pEndecaResourcedValuesResourceBundle) |
void |
setNavigationFiltersParameterName(java.lang.String pNodeParameterName) |
void |
setObjectRenderingPageFragmentsByType(atg.nucleus.ServiceMap pRecordRenderingPageFragments) |
void |
setRecordOffsetPlaceHolderValue(java.lang.String pRecordOffsetParameterName) |
void |
setRecordProductIdPropertyName(java.lang.String pRecordProductIdPropertyName) |
void |
setRecordsPerPagePlaceHolderValue(java.lang.String pRecordsPerPageParameterName) |
void |
setRecordTypePropertyName(java.lang.String pRecordTypePropertyName) |
void |
setRefinementMenuContentItemType(java.lang.String pRefinementMenuContentItemType) |
void |
setResultContentItemPageFragments(atg.nucleus.ServiceMap pResultContentItemPageFragments) |
void |
setResultContentItemTitleLookupKeys(java.util.Map pAlternateContentItemTitleLookupKeys) |
void |
setResultContentItemTitlePropertyNames(java.util.Map pResultContentItemTitlePropertyNames) |
void |
setResultsListContentItemType(java.lang.String pResultsListContentItemType) |
void |
setShowRawEndecaResourcedValues(boolean pShowRawEndecaResourcedValues) |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, 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, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
protected java.lang.String mRefinementMenuContentItemType
protected java.lang.String mBreadcrumbContentItemType
protected java.lang.String mResultsListContentItemType
protected java.util.Map mCatalogRootCategoryMap
protected java.lang.String mAutoSuggestURI
protected java.lang.Integer mAutoSuggestMinLength
protected java.lang.String[] mAlternateResultContentItemTypes
protected atg.nucleus.ServiceMap mResultContentItemPageFragments
protected atg.web.PageFragment mDefaultResultContentItemPageFragment
protected java.util.Map mResultContentItemTitleLookupKeys
protected java.util.Map mEndecaResourcedValuePropertyNames
protected boolean mShowRawEndecaResourcedValues
protected java.lang.String mEndecaResourcedValuesResourceBundle
protected java.lang.String mRecordTypePropertyName
protected atg.web.PageFragment mDefaultObjectRenderingPageFragment
protected atg.nucleus.ServiceMap mObjectRenderingPageFragmentsByType
protected java.util.Map<java.lang.String,java.lang.String> mCollectionPropertyNames
protected java.lang.String mRecordProductIdPropertyName
protected java.util.Map mResultContentItemTitlePropertyNames
public java.lang.String getNavigationFiltersParameterName()
public void setNavigationFiltersParameterName(java.lang.String pNodeParameterName)
public java.lang.String getRecordsPerPagePlaceHolderValue()
public void setRecordsPerPagePlaceHolderValue(java.lang.String pRecordsPerPageParameterName)
public java.lang.String getRecordOffsetPlaceHolderValue()
public void setRecordOffsetPlaceHolderValue(java.lang.String pRecordOffsetParameterName)
public void setDefaultContentURI(java.lang.String pDefaultContentURI)
pDefaultContentURI
- the default content URIpublic java.lang.String getDefaultContentURI()
public java.lang.String getRefinementMenuContentItemType()
public void setRefinementMenuContentItemType(java.lang.String pRefinementMenuContentItemType)
public java.lang.String getBreadcrumbContentItemType()
public void setBreadcrumbContentItemType(java.lang.String pBreadcrumbContentItemType)
public java.lang.String getResultsListContentItemType()
public void setResultsListContentItemType(java.lang.String pResultsListContentItemType)
public java.util.Map getCatalogRootCategoryMap()
public void setCatalogRootCategoryMap(java.util.Map pCatalogRootCategoryMap)
public java.lang.String getAutoSuggestURI()
public void setAutoSuggestURI(java.lang.String pAutoSuggestURI)
pAutoSuggestURI
- the auto suggest URI for endeca auto suggest panelspublic java.lang.Integer getAutoSuggestMinLength()
public void setAutoSuggestMinLength(java.lang.Integer pAutoSuggestMinLength)
pAutoSuggestMinLength
- the number of letters to enter before checking for suggested completionspublic java.lang.String[] getAlternateResultContentItemTypes()
public void setAlternateResultContentItemTypes(java.lang.String[] pAlternateResultContentItemTypes)
public atg.nucleus.ServiceMap getResultContentItemPageFragments()
public void setResultContentItemPageFragments(atg.nucleus.ServiceMap pResultContentItemPageFragments)
public atg.web.PageFragment getDefaultResultContentItemPageFragment()
The fragment is used in cases where there isn't a type specific fragment
specified in resultContentItemPageFragments
Map
public void setDefaultResultContentItemPageFragment(atg.web.PageFragment pDefaultResultContentItemPageFragment)
public java.util.Map getResultContentItemTitleLookupKeys()
endecaResourcedValuePropertyNames
configuration
propertypublic void setResultContentItemTitleLookupKeys(java.util.Map pAlternateContentItemTitleLookupKeys)
public java.util.Map getEndecaResourcedValuePropertyNames()
public void setEndecaResourcedValuePropertyNames(java.util.Map pEndecaResourcedValuePropertyNames)
public boolean isShowRawEndecaResourcedValues()
endecaResourcedValuesResourceBundle
property.public void setShowRawEndecaResourcedValues(boolean pShowRawEndecaResourcedValues)
public java.lang.String getEndecaResourcedValuesResourceBundle()
showRawEndecaResourcedValues
is configured
to false
public void setEndecaResourcedValuesResourceBundle(java.lang.String pEndecaResourcedValuesResourceBundle)
public java.lang.String getRecordTypePropertyName()
public void setRecordTypePropertyName(java.lang.String pRecordTypePropertyName)
public atg.web.PageFragment getDefaultObjectRenderingPageFragment()
public void setDefaultObjectRenderingPageFragment(atg.web.PageFragment pDefaultRecordRenderingPageFragment)
public atg.nucleus.ServiceMap getObjectRenderingPageFragmentsByType()
public void setObjectRenderingPageFragmentsByType(atg.nucleus.ServiceMap pRecordRenderingPageFragments)
public java.util.Map<java.lang.String,java.lang.String> getCollectionPropertyNames()
public void setCollectionPropertyNames(java.util.Map<java.lang.String,java.lang.String> pCollectionPropertyName)
public java.lang.String getRecordProductIdPropertyName()
public void setRecordProductIdPropertyName(java.lang.String pRecordProductIdPropertyName)
public java.util.Map getResultContentItemTitlePropertyNames()
public void setResultContentItemTitlePropertyNames(java.util.Map pResultContentItemTitlePropertyNames)