org.ametys.plugins.repository.data.holder

Interface ModifiableModelAwareDataHolder

All Superinterfaces:

DataHolder, ModelAwareDataHolder, ModifiableDataHolder

All Known Subinterfaces:

CommentableContent, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, ContentValue, Course, CourseList, CoursePart, DefaultModifiableModelAwareDataHolder, ModifiableDefaultContent, ModifiableDefaultWebContent, ModifiableModelAwareComposite, ModifiableModelAwareRepeaterEntry, OrgUnit, Person, Program, Site, SubProgram

public interface ModifiableModelAwareDataHolder
extends ModifiableDataHolder, ModelAwareDataHolder

Interface for modifiable data containers with models

Method Summary

Modifier and Type	Method and Description
ModifiableModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModifiableModelAwareRepeater	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

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

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

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames

Method Detail

getComposite

ModifiableModelAwareComposite getComposite(String compositePath)
                                    throws IllegalArgumentException,
                                           UndefinedItemPathException,
                                           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 ModelAwareDataHolder

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

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getRepeater

ModifiableModelAwareRepeater getRepeater(String repeaterPath)
                                  throws IllegalArgumentException,
                                         UndefinedItemPathException,
                                         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 ModelAwareDataHolder

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

UndefinedItemPathException - if the given repeater path is not defined by the model

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

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

getComposite

ModifiableModelAwareComposite getComposite(String compositePath,
                                           boolean createNew)
                                    throws IllegalArgumentException,
                                           UndefinedItemPathException,
                                           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:

UndefinedItemPathException - if the given composite path is not defined by the model

BadDataPathCardinalityException - if the definition 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

ModifiableModelAwareRepeater getRepeater(String repeaterPath,
                                         boolean createNew)
                                  throws IllegalArgumentException,
                                         UndefinedItemPathException,
                                         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:

UndefinedItemPathException - if the given composite path is not defined by the model

BadDataPathCardinalityException - if the definition 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,
              UndefinedItemPathException,
              BadItemTypeException,
              BadDataPathCardinalityException

Sets the value of the data at the given path

Parameters:

dataPath - path of the data

value - the value to set. The type of this value will be given by the model, but if not model is associated to the path, an UnsupportedOperationException is thrown. Use the 3 arguments versions in that case.

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

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

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

removeValue

void removeValue(String dataPath)
          throws IllegalArgumentException,
                 UndefinedItemPathException,
                 BadItemTypeException,
                 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:

UndefinedItemPathException - if the given data path is not defined by the model

BadDataPathCardinalityException - if the definition 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