org.ametys.plugins.repository.data.ametysobject

Interface ModifiableModelLessDataAwareAmetysObject

All Superinterfaces:

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

All Known Subinterfaces:

ModifiablePage, ModifiableZone, ModifiableZoneItem

All Known Implementing Classes:

DefaultPage, DefaultZone, DefaultZoneItem, JCRProjectMember, Project, ProjectCategory

public interface ModifiableModelLessDataAwareAmetysObject
extends ModifiableModelLessDataHolder, ModelLessDataAwareAmetysObject

Model less AmetysObject that can handle modifiable data.

Method Summary

Modifier and Type	Method and 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 ModifiableModelLessRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
default ModifiableModelLessRepeater	getRepeater(String repeaterPath, boolean createNew) Retrieves the repeater at the given path
default void	removeValue(String dataPath) Removes the value of the data stored in the repository 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

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

getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, isMultiple

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

copyTo, getDataNames

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.holder.ModelLessDataHolder

toSAX, toSAX

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

dataToSAX, dataToSAX, dataToSAX, dataToSAX

Method Detail

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository 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

getRepeater

default ModifiableModelLessRepeater getRepeater(String repeaterPath)
                                         throws IllegalArgumentException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Specified by:

getRepeater in interface ModelLessDataAwareAmetysObject

Specified by:

getRepeater in interface ModelLessDataHolder

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelLessDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists

Throws:

IllegalArgumentException - if the given repeater path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a repeater

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository 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

getRepeater

default ModifiableModelLessRepeater getRepeater(String repeaterPath,
                                                boolean createNew)
                                         throws IllegalArgumentException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: ModifiableModelLessDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelLessDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

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

Returns:

the repeater

Throws:

IllegalArgumentException - if the given repeater path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a repeater

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)
               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

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

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 value of the data stored in the repository 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

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

UnknownTypeException

BadItemTypeException