Package com.adobe.aem.commons.assetshare.components.predicates

Interface PagePredicate

All Superinterfaces:

Component, com.adobe.cq.export.json.ComponentExporter, com.adobe.cq.wcm.core.components.models.form.Field, Predicate

@ConsumerType
public interface PagePredicate
extends Predicate

Represents the overarching QueryBuilder predicate rules that apply general to the search. This is called PagePredicate as these values can come from multiple components across the Search page, however most are sourced from the Search Results component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PagePredicate.ParamTypes	The QB parameter types that getPredicateGroup(..) can build (or ask it to not build).

Method Summary

Modifier and Type	Method	Description
String	getGuessTotal()
int	getLimit()
String	getOrderBy()
String	getOrderBySort()
Map<String,String>	getParams()	Deprecated.
Map<String,String>	getParams(PagePredicate.ParamTypes... excludeParamTypes)	Deprecated.
List<String>	getPaths()
com.day.cq.search.PredicateGroup	getPredicateGroup()	Creates a predicate group that represents the top-level query configuration that fallback on or are based on the page.
com.day.cq.search.PredicateGroup	getPredicateGroup(PagePredicate.ParamTypes... excludeParamTypes)	Creates a predicate group that represents the top-level query configuration that fallback on or are based on the page.

Methods inherited from interface com.adobe.aem.commons.assetshare.components.Component

isReady

Methods inherited from interface com.adobe.cq.wcm.core.components.models.form.Field

getExportedType, getHelpMessage, getId, getName, getTitle, getValue

Methods inherited from interface com.adobe.aem.commons.assetshare.components.predicates.Predicate

getComponentUpdateMethod, getFormId, getGroup, getInitialValue, getInitialValues, isAutoSearch, isExpanded

Method Detail

getOrderBy

String getOrderBy()

Returns:

the property which to order by.

getOrderBySort

String getOrderBySort()

Returns:

the sort order; asc or desc.

getLimit

int getLimit()

Returns:

the limit.

getGuessTotal

String getGuessTotal()

Returns:

the configured guessTotal value.

getPaths

List<String> getPaths()

Returns:

a list of absolute JCR paths that a query should be restricted to.

getPredicateGroup

com.day.cq.search.PredicateGroup getPredicateGroup()

Creates a predicate group that represents the top-level query configuration that fallback on or are based on the page. This method builds out a fixed set of QB predicates.

Returns:

the predicate group that contains the query predicates.

getPredicateGroup

com.day.cq.search.PredicateGroup getPredicateGroup(PagePredicate.ParamTypes... excludeParamTypes)

Creates a predicate group that represents the top-level query configuration that fallback on or are based on the page. This method builds out a fixed set of QB predicates.

Parameters:

excludeParamTypes - the query parameter types to exclude when building this.

Returns:

the predicate group that contains the query predicates.

getParams

@Deprecated
Map<String,String> getParams()

Deprecated.

Deprecated. Use getPredicateGroup() instead.

Returns:

a map of representation of the QueryBuilder predicate params.

getParams

@Deprecated
Map<String,String> getParams(PagePredicate.ParamTypes... excludeParamTypes)

Deprecated.

Deprecated. Use getPredicateGroup(ParamTypes... excludeParamTypes) instead.

Parameters:

excludeParamTypes - the query parameter types to exclude when building this.

Returns:

the predicate group that contains the query predicates.