Package org.ametys.plugins.repository.data.ametysobject

Interface ModifiableModelLessDataAwareAmetysObject

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, ModelLessDataAwareAmetysObject, ModelLessDataHolder, ModifiableAmetysObject, ModifiableDataHolder, ModifiableModelLessDataHolder

All Known Subinterfaces:

ModelLessJCRAmetysObject, ModifiablePage, ModifiableZone, ModifiableZoneItem

All Known Implementing Classes:

AbstractSitemapElement, AbstractSurveyElement, Activity, CMISRootResourcesCollection, DefaultLink, DefaultPage, DefaultZone, DefaultZoneItem, JCRProjectMember, JCRResourcesCollection, Project, Sitemap, Survey, SurveyPage, SurveyQuestion, Thesaurus

public interface ModifiableModelLessDataAwareAmetysObject
extends ModifiableModelLessDataHolder, ModelLessDataAwareAmetysObject, ModifiableAmetysObject

Model less AmetysObject that can handle modifiable data.

Method Summary

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

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject

dataToJSON, dataToSAX, getModelItemTypeExtensionPoint, getType, getValue, getValue, getValueOfType, getValueOfType, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

dataToJSON, dataToSAX, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Method Details

getDataHolder

ModifiableModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelLessDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getComposite

default 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 DataAwareAmetysObject

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelLessDataAwareAmetysObject

Specified by:

getComposite in interface ModelLessDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelLessDataHolder

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

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

Description copied from interface: ModifiableModelLessDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelLessDataHolder

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:

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

synchronizeValues

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

Description copied from interface: ModifiableModelLessDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelLessDataHolder

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

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

Description copied from interface: ModifiableModelLessDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

value - the value to set. To empty a value, use ModifiableModelLessDataHolder.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

default void setValue(String dataPath,
 Object value,
 String dataType)
               throws IllegalArgumentException,
BadItemTypeException,
UnknownDataException,
BadDataPathCardinalityException

Description copied from interface: ModifiableModelLessDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

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

dataType - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

default void removeValue(String dataPath)
                  throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: ModifiableModelLessDataHolder

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Specified by:

removeValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

Throws:

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

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

UnknownTypeException

getRepositoryData

default ModifiableRepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataAwareAmetysObject

Specified by:

getRepositoryData in interface DataHolder

Specified by:

getRepositoryData in interface ModifiableDataHolder

Returns:

the repository data used by this DataHolder

getParentDataHolder

default 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 DataAwareAmetysObject

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface ModelLessDataAwareAmetysObject

Specified by:

getParentDataHolder in interface ModelLessDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Specified by:

getParentDataHolder in interface ModifiableModelLessDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

default ModifiableModelLessDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataAwareAmetysObject

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModelLessDataAwareAmetysObject

Specified by:

getRootDataHolder in interface ModelLessDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Specified by:

getRootDataHolder in interface ModifiableModelLessDataHolder

Returns:

the root DataHolder