Package org.ametys.odf.program.properties

Class NearestOrgUnitsProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

org.ametys.cms.model.properties.AbstractContentProperty<Content>

org.ametys.odf.program.properties.NearestOrgUnitsProperty

All Implemented Interfaces:

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

public class NearestOrgUnitsProperty
extends AbstractContentProperty<Content>
implements CriterionDefinitionAwareElementDefinition<ContentValue>, IndexationAwareElementDefinition<ContentValue,Content>

Property to get the nearest orgunits linked to a program item. This property seeks the orgunits in the parents when it's not defined in the given program item. It stop to the first parents who have orgunits

Field Summary

Fields

Modifier and Type	Field	Description
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
protected IndexationAwareElementDefinitionHelper	_indexationAwareElementDefinitionHelper	The indexation aware element definition helper
protected ODFHelper	_odfHelper	The ODF Helper

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

Method Summary

Modifier and Type	Method	Description
protected Set<? extends ModifiableContent>	_getLinkedContents(Content content)	Get the linked contents to index.
String	getContentTypeId()	Get the element's content type identifier.
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
String	getDefaultCriterionWidget()	Get the widget to use when rendering the property as a criterion
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
boolean	isMultiple()	Test if the element is multiple.
void	service(ServiceManager manager)

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

_toJSON, getModelItems, getTypeId, getValue, setContentTypeId, toSAX

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

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

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

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _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

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, 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, getValue, 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.model.ModelItemAccessor

getChild, getModelItem, hasModelItem

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

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition helper

_indexationAwareElementDefinitionHelper

protected IndexationAwareElementDefinitionHelper _indexationAwareElementDefinitionHelper

The indexation aware element definition helper

Constructor Details

NearestOrgUnitsProperty

public NearestOrgUnitsProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentProperty<Content>

Throws:

ServiceException

_getLinkedContents

protected Set<? extends ModifiableContent> _getLinkedContents(Content content)

Description copied from class: AbstractContentProperty

Get the linked contents to index.

Specified by:

_getLinkedContents in class AbstractContentProperty<Content>

Parameters:

content - The data holder

Returns:

The linked contents

getDefaultCriterionWidget

public String getDefaultCriterionWidget()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the widget to use when rendering the property as a criterion

Specified by:

getDefaultCriterionWidget in interface CriterionDefinitionAwareElementDefinition<ContentValue>

Returns:

The widget to use, or null if no specific widget is necessary.

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<ContentValue>

Overrides:

isMultiple in class DefaultElementDefinition<ContentValue>

Returns:

true if the metadata is multiple.

getContentTypeId

public String getContentTypeId()

Description copied from interface: ContentElementDefinition

Get the element's content type identifier.

Specified by:

getContentTypeId in interface ContentElementDefinition

Returns:

the element's content type identifier.

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<ContentValue>

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<ContentValue,Content>

Returns:

the name of the element's solr sort field