org.ametys.plugins.repository.data.type

Interface RepositoryModelItemGroupType

All Superinterfaces:

ModelItemGroupType, ModelItemType, PluginAware, RepositoryModelItemType

All Known Implementing Classes:

CompositeRepositoryModelItemType, RepeaterRepositoryModelItemType

public interface RepositoryModelItemGroupType
extends RepositoryModelItemType, ModelItemGroupType

Interface for types of model item groups stored in the repository

Method Summary

Modifier and Type	Method and Description
default ModifiableRepositoryData	add(ModifiableRepositoryData parentData, String name) Add a group into the given repository data
String	getNodeType() Retrieves the type of node used for this type
default boolean	isCompatible(RepositoryData parentData, String name) Checks if the value in the given repository data is compatible with the item type
default RepositoryData	read(RepositoryData parentData, String name) Read the group in the given repository data

Methods inherited from interface org.ametys.runtime.model.type.ModelItemType

getId, valueToSAX

Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware

setPluginInfo

Method Detail

read

default RepositoryData read(RepositoryData parentData,
                            String name)
                     throws BadItemTypeException

Read the group in the given repository data

Parameters:

parentData - repository data containing the group

name - the name of the group to read

Returns:

the repository data representing the read group

Throws:

BadItemTypeException - if the reading value doesn't match this element type

add

default ModifiableRepositoryData add(ModifiableRepositoryData parentData,
                                     String name)

Add a group into the given repository data

Parameters:

parentData - repository where to add the group

name - the name of the group to add

Returns:

the repository data representing the added group

isCompatible

default boolean isCompatible(RepositoryData parentData,
                             String name)
                      throws UnknownDataException

Description copied from interface: RepositoryModelItemType

Checks if the value in the given repository data is compatible with the item type

Specified by:

isCompatible in interface RepositoryModelItemType

Parameters:

parentData - repository data containing the data to check

name - the name of the data to check

Returns:

true if the data type matches the current type, false otherwise

Throws:

UnknownDataException - if there is no data in the parent repository data with this name

getNodeType

String getNodeType()

Retrieves the type of node used for this type

Returns:

the type of node used for this type