com.endeca.soleng.urlformatter
Interface NavStateUrlParam

All Superinterfaces:

Cloneable, UrlParam

public interface NavStateUrlParam
extends UrlParam

An interface used internally by an UrlState to manage state for navigation pages. This is an internal interface used by an UrlState. You shouldn't need to use this interface unless you are implementing a custom UrlFormatter.

See Also:

UrlFormatter.createNavStateUrlParam(UrlState)

Method Summary

com.endeca.navigation.DimLocationList	getDimLocationList() Internal method delegated from an UrlState.
void	removeDescriptor(com.endeca.navigation.DimVal pDescriptor) Internal method delegated from an UrlState.
void	selectAncestor(com.endeca.navigation.DimVal pAncestor, com.endeca.navigation.DimVal pDescriptor) Internal method delegated from an UrlState.
void	selectRefinement(com.endeca.navigation.Dimension pRefinementDimension, com.endeca.navigation.DimVal pRefinement) Internal method delegated from an UrlState.
void	selectRefinement(com.endeca.navigation.DimLocation pRefinement) Internal method delegated from an UrlState.
void	setDimLocationList(com.endeca.navigation.DimensionList pDescriptorDimensionList) Internal method delegated from an UrlState.
void	setDimLocationList(com.endeca.navigation.DimLocationList pDimLocationList) Internal method delegated from an UrlState.
void	setDimLocationList(com.endeca.navigation.ERec pERec, com.endeca.navigation.DimValList pDimValList) Internal method delegated from an UrlState.

Methods inherited from interface com.endeca.soleng.urlformatter.UrlParam

clone, getEncodedKey, getEncodedValue, getKey, getValue

Method Detail

setDimLocationList

void setDimLocationList(com.endeca.navigation.DimLocationList pDimLocationList)

Internal method delegated from an UrlState.

See Also:

UrlState.setNavState(DimLocationList)

setDimLocationList

void setDimLocationList(com.endeca.navigation.DimensionList pDescriptorDimensionList)

Internal method delegated from an UrlState.

See Also:

UrlState.setNavState(DimensionList)

setDimLocationList

void setDimLocationList(com.endeca.navigation.ERec pERec,
                        com.endeca.navigation.DimValList pDimValList)

Internal method delegated from an UrlState.

See Also:

UrlState.setNavState(ERec,DimValList)

getDimLocationList

com.endeca.navigation.DimLocationList getDimLocationList()

Internal method delegated from an UrlState.

See Also:

UrlState.getNavState()

selectAncestor

void selectAncestor(com.endeca.navigation.DimVal pAncestor,
                    com.endeca.navigation.DimVal pDescriptor)

Internal method delegated from an UrlState.

See Also:

UrlState.selectAncestor(DimVal,DimVal,boolean)

removeDescriptor

void removeDescriptor(com.endeca.navigation.DimVal pDescriptor)

Internal method delegated from an UrlState.

See Also:

UrlState.removeDescriptor(DimVal,boolean)

selectRefinement

void selectRefinement(com.endeca.navigation.Dimension pRefinementDimension,
                      com.endeca.navigation.DimVal pRefinement)

Internal method delegated from an UrlState.

See Also:

UrlState.selectRefinement(Dimension,DimVal,boolean)

selectRefinement

void selectRefinement(com.endeca.navigation.DimLocation pRefinement)

Internal method delegated from an UrlState.

See Also:

UrlState.selectRefinement(DimLocation,boolean)