Package org.ametys.cms.search.systemprop

Class AbstractUserSystemProperty<X extends ModelAwareDataAwareAmetysObject>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.model.properties.AbstractProperty<UserIdentity,X>

org.ametys.cms.search.systemprop.AbstractSystemProperty<UserIdentity,X>

org.ametys.cms.search.systemprop.AbstractUserSystemProperty<X>

Type Parameters:

X - type of ametys object supported by this property

All Implemented Interfaces:

Comparable<ModelItem>, Property<UserIdentity,X>, SystemProperty<UserIdentity,X>, ElementDefinition<UserIdentity>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

AbstractUserIndexableSystemProperty, LastSynchronizationUserSystemProperty

public abstract class AbstractUserSystemProperty<X extends ModelAwareDataAwareAmetysObject>
extends AbstractSystemProperty<UserIdentity,X>

Abstract class providing base functionality for a user-typed SystemProperty.

Field Summary

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

_availableTypesExtensionPoint, _context, _manager

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

Constructor Summary

Constructors

Constructor	Description
AbstractUserSystemProperty()

Method Summary

Modifier and Type	Method	Description
protected abstract UserIdentity	_getUserIdentityValue(X ametysObject)	Get the value as UserIdentity
String	getRenderer()	Get the renderer.
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(X ametysObject)	Get the property's value

Methods inherited from class org.ametys.cms.search.systemprop.AbstractSystemProperty

_getNameConfigurationAttribute, parseStringArray

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

_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize, getType, isEditable, service, setAvailableTypeExtensionPoint, setPluginInfo

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

_defaultValueToJSON, _getDefaultValues, _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, getDescription, getDisableConditions, getItemCheckers, getLabel, 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.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.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

getType, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX

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

getColumnWidth, getConverter, isDisplayable

Constructor Details

AbstractUserSystemProperty

public AbstractUserSystemProperty()

Method Details

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Returns:

The column renderer.

_getUserIdentityValue

protected abstract UserIdentity _getUserIdentityValue(X ametysObject)

Get the value as UserIdentity

Parameters:

ametysObject - the ametys object

Returns:

the user identity

getValue

public Object getValue(X ametysObject)

Description copied from interface: Property

Get the property's value

Parameters:

ametysObject - the ametysObject containing the property

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<UserIdentity,X extends ModelAwareDataAwareAmetysObject>

Returns:

the id of the property's type