Package org.ametys.runtime.model

Interface ModelItem

All Superinterfaces:

Comparable<ModelItem>, Labelable, ModifiableLabelable

All Known Subinterfaces:

RestrictedModelItem<T>

All Known Implementing Classes:

AbstractModelItem, AttributeDefinition, CompareView.CompareElementDefinition, CompositeDefinition, ContentAttributeDefinition, ContentRestrictedCompositeDefinition, ContentRestrictedRepeaterDefinition, ElementDefinition, ModelItemGroup, RepeaterDefinition, RichTextAttributeDefinition, ServiceParameter, ViewParameter

public interface ModelItem
extends ModifiableLabelable, Comparable<ModelItem>

Interface for model items

Field Summary

Fields

Modifier and Type	Field	Description
static 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
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
ModelItemType	getType()	Retrieves the type.
void	setModel(Model model)	Sets the model of the element
void	setParent(ModelItemGroup parent)	Sets the parent of the item
void	setType(ModelItemType type)	Set the type.
Map<String,Object>	toJSON(DefinitionContext context)	Converts the model item in a JSON map

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 Detail

ITEM_PATH_SEPARATOR

static final String ITEM_PATH_SEPARATOR

Separator used for item paths in definitions

See Also:

Constant Field Values

Method Detail

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

getType

ModelItemType getType()

Retrieves the type.

Returns:

the type.

setType

void setType(ModelItemType type)

Set the type.

Parameters:

type - the type.