Package org.ametys.plugins.repository.data.holder

Interface ModifiableModelLessDataHolder

All Superinterfaces:

DataHolder, ModelLessDataHolder, ModifiableDataHolder

All Known Subinterfaces:

ModelLessJCRAmetysObject, ModifiableModelLessDataAwareAmetysObject, ModifiablePage, ModifiableZone, ModifiableZoneItem

All Known Implementing Classes:

AbstractSurveyElement, DefaultLink, DefaultModifiableModelLessDataHolder, DefaultPage, DefaultZone, DefaultZoneItem, JCRProjectMember, ModifiableModelLessComposite, Project, Sitemap, Survey, SurveyPage, SurveyQuestion

public interface ModifiableModelLessDataHolder
extends ModifiableDataHolder, ModelLessDataHolder

Interface for modifiable data containers without models

Method Summary

Modifier and Type	Method	Description
ModifiableModelLessComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableModelLessComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
Optional<? extends ModifiableModelLessDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModifiableModelLessDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
void	removeValue(String dataPath)	Removes the stored value of the data at the given path
void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
void	setValue(String dataPath, Object value, String dataTypeId)	Sets the value of the data at the given path
boolean	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, dataToSAX, dataToSAX, getDataNames

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

dataToSAX, dataToSAX, getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, hasValueOrEmpty, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder

getRepositoryData

Method Details

getComposite

ModifiableModelLessComposite getComposite(String compositePath)
                                   throws IllegalArgumentException,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelLessDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the stored value at the given path is not a composite

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

getComposite

ModifiableModelLessComposite getComposite(String compositePath,
 boolean createNew)
                                   throws IllegalArgumentException,
BadItemTypeException,
BadDataPathCardinalityException

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Parameters:

compositePath - path of the composite to retrieve

createNew - true to create the composite if it does not exist, false otherwise

Returns:

the composite or null if createNew is false and value not exists or is empty

Throws:

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the stored value at the given path is not a composite

synchronizeValues

boolean synchronizeValues(Map<String,Object> values)
                   throws UnknownTypeException,
NotUniqueTypeException

Synchronizes the given values with the current ones

Parameters:

values - the values to synchronize

Returns:

true if some values have changed, false otherwise

Throws:

UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point

setValue

void setValue(String dataPath,
 Object value)
       throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
UnknownDataException,
BadDataPathCardinalityException

Sets the value of the data at the given path

Parameters:

dataPath - path of the data

value - the value to set. To empty a value, use setValue(String, Object, String) with a null value

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if there is no available type compatible with the given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the given value for this data holder's type extension point

UnknownDataException - if given the data path is composed of an inexisting group

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

setValue

void setValue(String dataPath,
 Object value,
 String dataTypeId)
       throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UnknownDataException,
BadDataPathCardinalityException

Sets the value of the data at the given path

Parameters:

dataPath - path of the data

value - the value to set. Give null to empty the value.

dataTypeId - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the given type is not available for this data holder's type extension point

BadItemTypeException - if the given type doesn't match the given value to set

UnknownDataException - if the given data path is composed of an inexisting group

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

removeValue

void removeValue(String dataPath)
          throws IllegalArgumentException,
UnknownDataException,
BadItemTypeException,
BadDataPathCardinalityException

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

Throws:

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the value of the parent of the given path is not an item container

UnknownDataException

getParentDataHolder

Optional<? extends ModifiableModelLessDataHolder> getParentDataHolder()

Description copied from interface: DataHolder

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface ModelLessDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

ModifiableModelLessDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModelLessDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Returns:

the root DataHolder