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

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

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

org.ametys.odf.program.properties.NearestOrgUnitsProperty

All Implemented Interfaces:

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

public class NearestOrgUnitsProperty
extends AbstractIndexableContentProperty<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 ODFHelper	_odfHelper	The ODF Helper

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

_criterionDefinitionHelper, _indexationAwareElementDefinitionHelper

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

_context

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.
String	getDefaultCriterionWidget()	Get the widget to use when rendering this item as a criterion, if no other widget is specified on criterion
boolean	isMultiple()	Test if the element is multiple.
void	service(ServiceManager manager)	The criterion definition helper

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

_toJSON, getModelItems, getTypeId, getValue, setContentTypeId, toSAX

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

getCriterionType, getCriterionTypeId, getSolrSortFieldName

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

_getNameConfigurationAttribute, _parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize

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

getType, init, isEditable, 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

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

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

valueToJSON, valueToSAX

Field Details

_odfHelper

protected ODFHelper _odfHelper

The ODF Helper

Constructor Details

NearestOrgUnitsProperty

public NearestOrgUnitsProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

The criterion definition helper

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractIndexableContentProperty<Content>

Throws:

ServiceException

_getLinkedContents

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

Description copied from class: AbstractIndexableContentProperty

Get the linked contents to index.

Specified by:

_getLinkedContents in class AbstractIndexableContentProperty<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 this item as a criterion, if no other widget is specified on criterion

Returns:

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

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.

Returns:

the element's content type identifier.