public class CategoryNavigationSuggestion extends AbstractNavigationSuggestion implements NavigationSuggestion
This class implements the NavigationSuggestion
interface to provide navigation suggestions
for 'Categories' of the catalog entries from the catalog group search index. It will return all of the Categories
scoped to the current catalog and store.
Below is an XML snippet of the information the webservice will return for this navigation suggestion handler. The information returned is:
<_cat:CatalogNavigationView>
<_cat:BreadCrumbTrailView/>
<_wcf:UserData/>
<_cat:SuggestionView>
<_cat:Identifier>Category</_cat:Identifier>
<_cat:Label>Category</_cat:Label>
<_cat:Entry>
<_cat:Name>Apparel</_cat:Name>
<_cat:Value>10129</_cat:Value>
<_cat:Image>images/catalog/apparel/Kids_clothing_sm.jpg</_cat:Image>
<_cat:UserData>
<_wcf:UserDataField name="FULL_PATH">Apparel</_wcf:UserDataField>
<_wcf:UserDataField name="CATEGORY_SEPARATOR"> > </_wcf:UserDataField>
</_cat:UserData>
</_cat:Entry>
<_cat:Entry>
<_cat:Name>Sleepers and Pyjamas</_cat:Name>
<_cat:Value>10130</_cat:Value>
<_cat:Image>images/catalog/apparel/Sleepwear_sm.jpg</_cat:Image>
<_cat:UserData>
<_wcf:UserDataField name="FULL_PATH">Apparel > Sleepers and Pyjamas</_wcf:UserDataField>
<_wcf:UserDataField name="CATEGORY_SEPARATOR"> > </_wcf:UserDataField>
</_cat:UserData>
</_cat:Entry>
<_cat:Entry>
<_cat:Name>Tops</_cat:Name>
<_cat:Value>10131</_cat:Value>
<_cat:Image>images/catalog/apparel/girls_boys_tops_sm.jpg</_cat:Image>
<_cat:UserData>
<_wcf:UserDataField name="FULL_PATH">Apparel > Tops</_wcf:UserDataField>
<_wcf:UserDataField name="CATEGORY_SEPARATOR"> > </_wcf:UserDataField>
</_cat:UserData>
</_cat:Entry>
<_cat:Entry>
<_cat:Name>Bottoms</_cat:Name>
<_cat:Value>10132</_cat:Value>
<_cat:Image>images/catalog/apparel/girls_boys_bottoms_sm.jpg</_cat:Image>
<_cat:UserData>
<_wcf:UserDataField name="FULL_PATH">Apparel > Bottoms</_wcf:UserDataField>
<_wcf:UserDataField name="CATEGORY_SEPARATOR"> > </_wcf:UserDataField>
</_cat:UserData>
</_cat:Entry>
<_cat:Entry>
<_cat:Name>Girls Dresses and Skirts</_cat:Name>
<_cat:Value>10133</_cat:Value>
<_cat:Image>images/catalog/apparel/dresses_skirts_sm.jpg</_cat:Image>
<_cat:UserData>
<_wcf:UserDataField name="FULL_PATH">Apparel > Girls Dresses and Skirts</_wcf:UserDataField>
<_wcf:UserDataField name="CATEGORY_SEPARATOR"> > </_wcf:UserDataField>
</_cat:UserData>
</_cat:Entry>
</_cat:SuggestionView>
</_cat:CatalogNavigationView>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
Constructor and Description |
---|
CategoryNavigationSuggestion() |
Modifier and Type | Method and Description |
---|---|
void |
populateSuggestion(java.lang.String profile,
com.ibm.commerce.catalog.facade.datatypes.SuggestionViewType suggestionView)
This method will populate the Category navigation suggestion for use in the storefront.
|
getProperties, setProperties
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getProperties, setProperties
public static final java.lang.String COPYRIGHT
public void populateSuggestion(java.lang.String profile, com.ibm.commerce.catalog.facade.datatypes.SuggestionViewType suggestionView)
This method will populate the Category navigation suggestion for use in the storefront.
populateSuggestion
in interface NavigationSuggestion
populateSuggestion
in class AbstractNavigationSuggestion
profile
- The search profile name.suggestionView
- An instantiated SuggestionViewType
object. If this navigation suggestion handler was
configured with a name, the identifier will be pre-populated in the SuggestionViewType
object.CategoryNavigationSuggestion
,
NavigationSuggestion.populateSuggestion(String, SuggestionViewType)
,
AbstractNavigationSuggestion.populateSuggestion(String, SuggestionViewType)