org.ametys.plugins.repository.data.ametysobject

Interface ModifiableModelAwareDataAwareAmetysObject

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, ModelAwareDataAwareAmetysObject, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

All Known Subinterfaces:

CommentableContent, ModifiableContent, ModifiableWebContent, ModifiableWorkflowAwareContent

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, Course, CourseList, CoursePart, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, Site, SubProgram

public interface ModifiableModelAwareDataAwareAmetysObject
extends ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder

Model aware AmetysObject that can handle modifiable data.

Method Summary

Modifier and Type	Method and Description
default ModifiableModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
default ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
ModifiableModelAwareDataHolder	getDataHolder() Returns the DataHolder of this AmetysObject.
default ModifiableModelAwareRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
default ModifiableModelAwareRepeater	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

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

getType, getValue, getValue, 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.ModelAwareDataHolder

toSAX, toSAX

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

dataToSAX, dataToSAX, dataToSAX, dataToSAX

Method Detail

getDataHolder

ModifiableModelAwareDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelAwareDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getComposite

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

Specified by:

getComposite in interface ModelAwareDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

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

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

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

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

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

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

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

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

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

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 repeater

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

removeValue

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

Description copied from interface: ModifiableModelAwareDataHolder

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 ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

BadItemTypeException

setValue

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

Description copied from interface: ModifiableModelAwareDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelAwareDataHolder

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