atg.endeca.assembler.navigation.filter

Interface RecordFilterBuilder

All Known Subinterfaces:

UrlStateAwareRecordFilterBuilder

All Known Implementing Classes:

AndRecordFilterBuilder, CatalogFilterBuilder, LanguageFilterBuilder, NotRecordFilterBuilder, OrRecordFilterBuilder, PriceListPairFilterBuilder, RecordFilterBuilderImpl, SiteFilterBuilder

public interface RecordFilterBuilder

The interface to be implemented by classes that provide runtime generation of record filters. Can also be used to produce an Endeca security filter. The implementations take care of Endeca record filter syntax and the names of MDEX record properties.

The record filter produced is intended be added to Endeca's list of record filters if the securityFilter property is false. If securityFilter is true, the result filter will be ANDed with output from other filter builders to produce a single Endeca security filter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	EMPTY_FILTER

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildRecordFilter() Builds and returns the Endeca record filter string.
boolean	isSecurityFilter()

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

EMPTY_FILTER

static final java.lang.String EMPTY_FILTER

See Also:

Constant Field Values

Method Detail

isSecurityFilter

boolean isSecurityFilter()

buildRecordFilter

java.lang.String buildRecordFilter()

Builds and returns the Endeca record filter string.

Returns:

the record filter string.