com.liferay.segments.criteria.contributor

Interface SegmentsCriteriaContributor

public interface SegmentsCriteriaContributor

Provides an interface for extending the segment Criteria by adding more filters.

Method Summary

Modifier and Type	Method and Description
default void	contribute(Criteria criteria, java.lang.String filterString, Criteria.Conjunction conjunction) Contributes a criterion to a segment criteria.
default Criteria.Criterion	getCriterion(Criteria criteria) Returns the contributed criterion from a criteria.
com.liferay.portal.odata.entity.EntityModel	getEntityModel() Returns the entity model associated to the contributor.
java.lang.String	getEntityName() Returns the name of the entity model associated to the contributor.
java.util.List<Field>	getFields(javax.portlet.PortletRequest portletRequest) Returns the list of fields that are supported by this contributor.
java.lang.String	getKey() Returns the contributor's key.
default java.lang.String	getLabel(java.util.Locale locale) Returns the label displayed in the user interface.
Criteria.Type	getType() Returns the contributor's type.

Method Detail

contribute

default void contribute(Criteria criteria,
                        java.lang.String filterString,
                        Criteria.Conjunction conjunction)

Contributes a criterion to a segment criteria.

Parameters:

criteria - the criteria

filterString - the filter of the criterion as a string

conjunction - the conjunction of the criterion

getCriterion

default Criteria.Criterion getCriterion(Criteria criteria)

Returns the contributed criterion from a criteria.

Parameters:

criteria - the criteria

Returns:

the contributed criterion.

getEntityModel

com.liferay.portal.odata.entity.EntityModel getEntityModel()

Returns the entity model associated to the contributor.

Returns:

getEntityName

java.lang.String getEntityName()

Returns the name of the entity model associated to the contributor.

Returns:

the name of the entity model associated to the contributor

getFields

java.util.List<Field> getFields(javax.portlet.PortletRequest portletRequest)

Returns the list of fields that are supported by this contributor.

Parameters:

portletRequest - the portlet request

Returns:

the list of fields that are supported by this contributor

getKey

java.lang.String getKey()

Returns the contributor's key. This key must be unique.

Returns:

the contributor's key

getLabel

default java.lang.String getLabel(java.util.Locale locale)

Returns the label displayed in the user interface.

Returns:

the label

getType

Criteria.Type getType()

Returns the contributor's type. See Criteria.Type.

Returns:

the contributor's type