Package org.ametys.web.trash

Class TrashElementSiteProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<String>

org.ametys.cms.model.properties.AbstractProperty<String,DefaultTrashElement>

org.ametys.cms.model.properties.AbstractIndexableProperty<String,String,DefaultTrashElement>

org.ametys.web.trash.TrashElementSiteProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<String,DefaultTrashElement>, CriterionDefinitionAwareElementDefinition<String,String,DefaultTrashElement>, IndexationAwareElementDefinition<String,DefaultTrashElement>, ElementDefinition<String>, ModelItem, PluginAware, Labelable, ModifiableLabelable

public final class TrashElementSiteProperty
extends AbstractIndexableProperty<String,String,DefaultTrashElement>

Indicate the site related to this trash element if any

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Item name for the site of the object

Fields inherited from class org.ametys.cms.model.properties.AbstractIndexableProperty

_criterionDefinitionHelper, _criterionType, _indexationAwareElementDefinitionHelper

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

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
I18nizableText	getDescription()	Retrieves the description.
I18nizableText	getLabel()	Retrieves the label.
protected String	getTypeId()	Retrieves the id of the property's type
String	getValue(DefaultTrashElement trashElement)	Get the element's value
static TrashElementSiteProperty	of(String availableTypesRole)	Create a trash element site property

Methods inherited from class org.ametys.cms.model.properties.AbstractIndexableProperty

_getCriterionDefinitionHelper, _getIndexationAwareElementDefinitionHelper, getCriterionType, getCriterionTypeId, getSolrSortFieldName, init

Methods inherited from class org.ametys.cms.model.properties.AbstractProperty

getType, isEditable, setPluginInfo

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters, toSAX

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDisableConditions, getItemCheckers, getModel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.ametys.cms.search.model.CriterionDefinitionAwareElementDefinition

convertQueryValue, getDefaultCriterionEnumerator, getDefaultCriterionOperator, getDefaultCriterionWidget, getDefaultCriterionWidgetParameters, getQuery

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

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

Methods inherited from interface org.ametys.cms.search.model.IndexationAwareElementDefinition

getSolrFacetFieldName, getSolrFieldName, getType, indexValue, isFacetable, isSortable

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

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

valueToJSON, valueToSAX

Field Details

NAME

public static final String NAME

Item name for the site of the object

See Also:

• Constant Field Values

Method Details

of

public static TrashElementSiteProperty of(String availableTypesRole)
                                   throws Exception

Create a trash element site property

Parameters:

availableTypesRole - the role of the extension point containing all available types for this property

Returns:

the created property

Throws:

Exception - if an error occurs

getValue

public String getValue(DefaultTrashElement trashElement)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Parameters:

trashElement - the ametysObject containing the element

Returns:

the values to index.

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<String,DefaultTrashElement>

Returns:

the id of the property's type

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Overrides:

getLabel in class AbstractModelItem

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Overrides:

getDescription in class AbstractModelItem

Returns:

the description.