Method to generate the navigation descriptors of the
ENEQuery for a selected refinement.
Generates the navigation descriptors of the ENEQuery
for a selected refinement. * descriptors that are ancestors of the refinements are removed.
Namespace: Endeca.NavigationAssembly: Endeca.Navigation (in Endeca.Navigation.dll) Version: 6.3.0.0 (6.3.0.853)
Syntax
C# |
---|
public static DimValIdList SelectRefinement( Navigation n, DimVal refinement ) |
Visual Basic |
---|
Public Shared Function SelectRefinement ( _ n As Navigation, _ refinement As DimVal _ ) As DimValIdList |
Visual C++ |
---|
public: static DimValIdList^ SelectRefinement( Navigation^ n, DimVal^ refinement ) |
Parameters
- n
- Type: Endeca.Navigation..::..Navigation
The current Navigation object.
- refinement
- Type: Endeca.Navigation..::..DimVal
The refinement dimension value (a DimVal object) that will be used to reduce the current record set.
Return Value
A DimValIdList object containing the IDs of the new navigation query descriptors after the addition of the specified refinement value to the existing set of navigation descriptors in the Navigation object specified by the n parameter.Remarks
This method adds a refinement value to
the set of navigation descriptors already existing in
a Navigation object and generates a new set
of navigation values for the ENEQuery.
In general, new refinements are placed at the end of
the descriptor list. Existing descriptors that are
ancestors of the refinements are removed.