Package org.ametys.runtime.model

Interface ModelItem

All Superinterfaces:

Comparable<ModelItem>, Labelable, ModifiableLabelable

All Known Subinterfaces:

ContentElementDefinition, ElementDefinition<T>, Property<T,X>, RestrictedModelItem<T>, SystemProperty<T,X>

All Known Implementing Classes:

AbstractContentProperty, AbstractDateTimeSystemProperty, AbstractModelItem, AbstractMultiTypedValuesProperty, AbstractMultiValuesProperty, AbstractProperty, AbstractSystemProperty, AbstractUserSystemProperty, AttributeDefinition, CollectionsSystemProperty, CommentsSystemProperty, CompositeDefinition, ContentAttributeDefinition, ContentPrivacySystemProperty, ContentRestrictedCompositeDefinition, ContentRestrictedRepeaterDefinition, ContentTypeSystemProperty, ContributorSystemProperty, CreationDateSystemProperty, CreatorSystemProperty, DefaultContentElementDefinition, DefaultElementDefinition, DegreeOrderProperty, DegreeTypeProperty, ElementRefProperty, FirstValidationSystemProperty, FirstValidatorSystemProperty, FulltextSystemProperty, HasLiveVersionSystemProperty, LanguageSystemProperty, LastMajorValidationSystemProperty, LastMajorValidatorSystemProperty, LastModifiedSystemProperty, LastValidationSystemProperty, LastValidatorSystemProperty, MemberProjectProperty, ModelItemGroup, MultiContentValuesProperty, MultiStringValuesProperty, OrgUnitAncestorProperty, OrphanSystemProperty, PagesSystemProperty, ParentContentSystemProperty, ParentProgramsProperty, ParentSubProgramsProperty, PinProperty, ProfiledGroupsTagsSystemProperty, ProgramSkillsProperty, RepeaterDefinition, RichTextAttributeDefinition, SemanticAnnotationSystemProperty, ServiceParameter, SharedSystemProperty, SiteSystemProperty, SiteTypeSystemProperty, SubProgramParentProgramProperty, TagsSystemProperty, TagsSystemProperty, ViewBasedFullTextSystemProperty, ViewParameter, WorkflowStepSystemProperty, WorkflowStepSystemProperty

public interface ModelItem
extends ModifiableLabelable, Comparable<ModelItem>

Interface for model items

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ITEM_PATH_SEPARATOR	Separator used for item paths in definitions

Method Summary

Modifier and Type	Method	Description
void	addItemChecker(ItemCheckerDescriptor itemChecker)	Add an item checker to the group
default String	getCriterionWidget()	Get the default widget to use when rendering this item as a criterion.
default Map<String,I18nizableText>	getCriterionWidgetParameters(Configuration configuration)	Get the widget parameters to use when rendering this item as a criterion.
DisableConditions	getDisableConditions()	Retrieves the disable condition.
Set<ItemCheckerDescriptor>	getItemCheckers()	Returns the ItemCheckerDescriptors associated with this group.
Model	getModel()	Retrieves the model of the item
ModelItemGroup	getParent()	Retrieves the parent of the item
String	getPath()	Retrieves the path of the model item
String	getPluginName()	Retrieves the name of the plugin declaring this element.
ModelItemType	getType()	Retrieves the type.
String	getWidget()	Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters()	Get the widget's parameters
void	setDisableConditions(DisableConditions disableConditions)	Sets the disable condition.
void	setModel(Model model)	Sets the model of the element
void	setParent(ModelItemGroup parent)	Sets the parent of the item
void	setPluginName(String pluginName)	Set the name of the plugin declaring this element.
void	setType(ModelItemType type)	Set the type.
void	setWidget(String widget)	Set the widget.
void	setWidgetParameters(Map<String,I18nizableText> params)	Set the widget's parameters
Map<String,Object>	toJSON(DefinitionContext context)	Converts the model item in a JSON map
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item

Methods inherited from interface java.lang.Comparable

compareTo

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

getDescription, getLabel, getName

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

setDescription, setLabel, setName

Field Details

ITEM_PATH_SEPARATOR

static final String ITEM_PATH_SEPARATOR

Separator used for item paths in definitions

See Also:

• Constant Field Values

Method Details

getItemCheckers

Set<ItemCheckerDescriptor> getItemCheckers()

Returns the ItemCheckerDescriptors associated with this group.

Returns:

the ItemCheckerDescriptors associated with this group.

addItemChecker

void addItemChecker(ItemCheckerDescriptor itemChecker)

Add an item checker to the group

Parameters:

itemChecker - the item checker to add

getPath

String getPath()

Retrieves the path of the model item

Returns:

the item path

getModel

Model getModel()

Retrieves the model of the item

Returns:

the model

setModel

void setModel(Model model)

Sets the model of the element

Parameters:

model - the model to set

getParent

ModelItemGroup getParent()

Retrieves the parent of the item

Returns:

the parent group

setParent

void setParent(ModelItemGroup parent)

Sets the parent of the item

Parameters:

parent - the parent to set

toJSON

Map<String,Object> toJSON(DefinitionContext context)
                   throws ProcessingException

Converts the model item in a JSON map

Parameters:

context - the context of the definition

Returns:

The model item as a JSON map, or an empty map

Throws:

ProcessingException - If an error occurs when converting the model item

toSAX

void toSAX(ContentHandler contentHandler,
 DefinitionContext context)
    throws SAXException

Generates SAX events for the model item

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definition

Throws:

SAXException - if an error occurs during the SAX events generation

getType

ModelItemType getType()

Retrieves the type.

Returns:

the type.

setType

void setType(ModelItemType type)

Set the type.

Parameters:

type - the type.

getPluginName

String getPluginName()

Retrieves the name of the plugin declaring this element.

Returns:

the plugin name.

setPluginName

void setPluginName(String pluginName)

Set the name of the plugin declaring this element.

Parameters:

pluginName - the plugin name.

getWidget

String getWidget()

Retrieves the widget to use for rendering.

Returns:

the widget or null if none is defined.

setWidget

void setWidget(String widget)

Set the widget.

Parameters:

widget - the widget.

getCriterionWidget

default String getCriterionWidget()

Get the default widget to use when rendering this item as a criterion.

Returns:

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

getWidgetParameters

Map<String,I18nizableText> getWidgetParameters()

Get the widget's parameters

Returns:

the widget's parameters

setWidgetParameters

void setWidgetParameters(Map<String,I18nizableText> params)

Set the widget's parameters

Parameters:

params - the parameters to set

getCriterionWidgetParameters

default Map<String,I18nizableText> getCriterionWidgetParameters(Configuration configuration)

Get the widget parameters to use when rendering this item as a criterion.

Parameters:

configuration - The widget parameters configuration

Returns:

The default widget parameters to use, or an empty Map if no specific widget parameters are necessary.

getDisableConditions

DisableConditions getDisableConditions()

Retrieves the disable condition.

Returns:

the disable condition or null if none is defined.

setDisableConditions

void setDisableConditions(DisableConditions disableConditions)

Sets the disable condition.

Parameters:

disableConditions - the disable condition.