Package org.ametys.odf.program.properties

Class SubProgramParentProgramProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.model.properties.AbstractProperty<Object,Content>

org.ametys.odf.program.properties.SubProgramParentProgramProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<Object,Content>, CriterionDefinitionAwareElementDefinition<Object>, IndexationAwareElementDefinition<Object,Content>, ElementDefinition<Object>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

public class SubProgramParentProgramProperty
extends AbstractProperty<Object,Content>
implements CriterionDefinitionAwareElementDefinition<Object>, IndexationAwareElementDefinition<Object,Content>

Property for attribute name of the parent Program of a SubProgram

Field Summary

Fields

Modifier and Type	Field	Description
protected ModelItemTypeExtensionPoint	_contentAttributeTypeEP	The Content Attribute Type Extension Point
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
protected ContentTypeExtensionPoint	_ctypeEP	The Content Type Extension Point
protected IndexationAwareElementDefinitionHelper	_indexationAwareElementDefinitionHelper	The indexation aware element definition helper
protected ODFHelper	_odfHelper	The ODF Helper
protected String	_programAttributeName	The program attribute name to index for subProgram
protected String	_programAttributeType	The program attribute type to index for subProgram

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
SubProgramParentProgramProperty()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(Content content)	Get the element's value
boolean	isMultiple()	Test if the element is multiple.
void	service(ServiceManager manager)

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

_getNameConfigurationAttribute, _parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, contextualize, getType, isEditable, 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, 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.cms.search.model.CriterionDefinitionAwareElementDefinition

convertQueryValue, getDefaultCriterionEnumerator, getDefaultCriterionOperator, getDefaultCriterionWidget, getDefaultCriterionWidgetParameters, getQuery, getType

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

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

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

getSolrFacetFieldName, getSolrFieldName, getSortValue, getType, indexValue, isFacetable, isSortable

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

initializeAfterModelItemsInitialization, valueToJSON, valueToSAX

Field Details

_odfHelper

protected ODFHelper _odfHelper

The ODF Helper

_ctypeEP

protected ContentTypeExtensionPoint _ctypeEP

The Content Type Extension Point

_contentAttributeTypeEP

protected ModelItemTypeExtensionPoint _contentAttributeTypeEP

The Content Attribute Type Extension Point

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition helper

_indexationAwareElementDefinitionHelper

protected IndexationAwareElementDefinitionHelper _indexationAwareElementDefinitionHelper

The indexation aware element definition helper

_programAttributeName

protected String _programAttributeName

The program attribute name to index for subProgram

_programAttributeType

protected String _programAttributeType

The program attribute type to index for subProgram

Constructor Details

SubProgramParentProgramProperty

public SubProgramParentProgramProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProperty<Object,Content>

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractProperty<Object,Content>

Throws:

ConfigurationException

getValue

public Object getValue(Content content)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Specified by:

getValue in interface IndexationAwareElementDefinition<Object,Content>

Specified by:

getValue in interface Property<Object,Content>

Parameters:

content - the ametysObject containing the element

Returns:

the values to index.

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<Object>

Overrides:

isMultiple in class DefaultElementDefinition<Object>

Returns:

true if the metadata is multiple.

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<Object,Content>

Returns:

the id of the property's type

getDefaultCriterionType

public IndexableElementType getDefaultCriterionType()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the type to use when rendering the element as a criterion

Specified by:

getDefaultCriterionType in interface CriterionDefinitionAwareElementDefinition<Object>

Returns:

the type to use for a criterion

getSolrSortFieldName

public String getSolrSortFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr sort field

Specified by:

getSolrSortFieldName in interface IndexationAwareElementDefinition<Object,Content>

Returns:

the name of the element's solr sort field