Package org.ametys.cms.search.model

Interface SystemProperty<T,X extends ModelAwareDataAwareAmetysObject>

Type Parameters:

T - type of the property values

X - type of ametys object supported by this property

All Superinterfaces:

Comparable<ModelItem>, ElementDefinition<T>, Labelable, ModelItem, ModifiableLabelable, Property<T,X>

All Known Implementing Classes:

AbstractDateTimeSystemProperty, AbstractSystemProperty, AbstractUserSystemProperty, CollectionsSystemProperty, CommentsSystemProperty, ContentPrivacySystemProperty, ContentTypeSystemProperty, ContributorSystemProperty, CreationDateSystemProperty, CreatorSystemProperty, FirstValidationSystemProperty, FirstValidatorSystemProperty, FulltextSystemProperty, HasLiveVersionSystemProperty, LanguageSystemProperty, LastMajorValidationSystemProperty, LastMajorValidatorSystemProperty, LastModifiedSystemProperty, LastValidationSystemProperty, LastValidatorSystemProperty, OrphanSystemProperty, PagesSystemProperty, ParentContentSystemProperty, ProfiledGroupsTagsSystemProperty, SemanticAnnotationSystemProperty, SharedSystemProperty, SiteSystemProperty, SiteTypeSystemProperty, TagsSystemProperty, TagsSystemProperty, WorkflowStepSystemProperty, WorkflowStepSystemProperty

public interface SystemProperty<T,X extends ModelAwareDataAwareAmetysObject>
extends Property<T,X>

Represents a universal property of a supported ModelAwareDataAwareAmetysObject Ex: content types, language or current workflow steps are some system properties supporting contents

Field Summary

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Method Summary

Modifier and Type	Method	Description
default Integer	getColumnWidth()	Get the column width.
default String	getConverter()	Get the property column converter.
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
default String	getRenderer()	Get the renderer.
Collection<SchemaDefinition>	getSchemaDefinitions()	Get the schema definitions brought by this property.
SearchField	getSearchField()	Get the SearchField representing this system property.
default Object	getSortValue(X ametysObject)	Get the sort value represented by this field in the given result ametys object.
default boolean	isDisplayable()	Get if the property can be displayed (i.e.
default boolean	isFacetable()	Gets if the property can be facetable
default boolean	isSearchable()	Get if the property can be searched on (i.e.
default boolean	isSortable()	Get if the property can be sorted on.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

_getParsedDefaultValues, getCriterionEnumerator, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getValidator, getValidatorConfiguration, isEditable, isMultiple, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON, toSAX

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Methods inherited from interface org.ametys.cms.model.properties.Property

getCriterionWidget, getCriterionWidgetParameters, getType, getValue, indexValue, setAvailableTypeExtensionPoint, valueToJSON, valueToJSON, valueToSAX, valueToSAX

Method Details

isSearchable

default boolean isSearchable()

Get if the property can be searched on (i.e. used in a SearchCriterion).

Returns:

true if the property can be searched on, false otherwise.

isDisplayable

default boolean isDisplayable()

Get if the property can be displayed (i.e. used in a ResultField).

Returns:

true if the property can be displayed, false otherwise.

isSortable

default boolean isSortable()

Get if the property can be sorted on.

Returns:

true if the property can be sorted on, false otherwise.

isFacetable

default boolean isFacetable()

Gets if the property can be facetable

Returns:

true if the property can be facetable, false otherwise.

getQuery

Query getQuery(Object value,
 Query.Operator operator,
 String language,
 Map<String,Object> contextualParameters)

Get the Query associated to the given value.

Parameters:

value - the user-submitted value for this property.

operator - In advanced search mode, the operator chosen by the user. null to use the criterion-defined operator (simple search mode).

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

The Query associated to the given value.

getRenderer

default String getRenderer()

Get the renderer.

Returns:

The column renderer.

getConverter

default String getConverter()

Get the property column converter.

Returns:

The property column converter.

getColumnWidth

default Integer getColumnWidth()

Get the column width.

Returns:

the default column width, can be null.

getSearchField

SearchField getSearchField()

Get the SearchField representing this system property.

Returns:

The search field representing this system property.

getSortValue

default Object getSortValue(X ametysObject)

Get the sort value represented by this field in the given result ametys object.

Parameters:

ametysObject - the result ametys object.

Returns:

the content sort value, must be scalar (String, long, double, Date).

getSchemaDefinitions

Collection<SchemaDefinition> getSchemaDefinitions()

Get the schema definitions brought by this property.

Returns:

The schema definitions used by this property.