com.endeca.navigation
Class RefinementConfig

Class representing a dynamic refinement config for a dimension
value. This will determine how refinements are computed under this
dimension value. Use of a dynamic refinement config will suppress
generation of a "More..." child dimension value. You can determine
whether there are more refinements than the ones shown by looking
at the "DGraph.More" property on the refinements' parent dimension value.
Any of the settings in this class can be set explicitly or defaulted to use
the corresponding dimension's settings in developer studio.

isDynamicRankingEnabled

A boolean indicating if Dynamic Ranking is
enabled for the dimension value.
Defaults to FALSE.

isDynamicRankingDisabled

public boolean isDynamicRankingDisabled()

Gets whether the dimension value has Dynamic Ranking disabled.

Returns:

A boolean indicating if Dynamic Ranking is
disabled for the dimension value.
Defaults to FALSE.

isDynamicRankingDefault

public boolean isDynamicRankingDefault()

Gets whether the dimension value has Dynamic Ranking set to use default.
If Dynamic Ranking is set to use default then Dynamic Ranking will
be enabled or disabled depending on the dimension's setting in
Developer Studio.

Returns:

A boolean indicating if Dynamic Ranking is
set to use default for the dimension value.
Defaults to TRUE.

isDynamicRankOrderStatic

public boolean isDynamicRankOrderStatic()

Gets whether the dimension value is sorted statically
(ordered by refinement sort order). This is only used if the
dimension value has Dynamic Ranking enabled.

Returns:

A boolean indicating if the dimension value is
sorted statically.
Defaults to FALSE.

isDynamicRankOrderDynamic

public boolean isDynamicRankOrderDynamic()

Gets whether the dimension value is sorted dynamically
(ordered by refinement count). This is only used if the
dimension value has Dynamic Ranking enabled.

Returns:

A boolean indicating if the dimension value is
sorted dynamically.
Defaults to FALSE.

isDynamicRankOrderDefault

public boolean isDynamicRankOrderDefault()

Gets whether the dimension value is sorted using the default.
If set to use default then the dimension value will be sorted statically
or dynamically depending on the dimension's setting in Developer Studio.
This is only used if the dimension value has Dynamic Ranking enabled.

Returns:

A boolean indicating if Dynamic Ranking is
set to use default for the dimension value.
Defaults to TRUE.