org.ametys.plugins.repository.data.holder

Interface ModifiableModelLessDataHolder

All Superinterfaces:

DataHolder, ModelLessDataHolder, ModifiableDataHolder

All Known Subinterfaces:

ModifiableModelLessDataAwareAmetysObject, ModifiablePage, ModifiableZone, ModifiableZoneItem

All Known Implementing Classes:

DefaultModifiableModelLessDataHolder, DefaultPage, DefaultZone, DefaultZoneItem, JCRProjectMember, ModifiableModelLessComposite, ModifiableModelLessRepeaterEntry, Project, ProjectCategory

public interface ModifiableModelLessDataHolder
extends ModifiableDataHolder, ModelLessDataHolder

Interface for modifiable data containers without models

Method Summary

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

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

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

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames

Method Detail

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

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

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 ModelLessDataHolder

Specified by:

getRepeater in interface ModifiableDataHolder

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

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

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 value stored in the repository at the given path is not a composite

getRepeater

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

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableDataHolder

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:

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

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

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

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

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

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

UnknownDataException - if the value at the given data path does not exist