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

Interface ModifiableModelAwareDataAwareAmetysObject

All Superinterfaces:

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

All Known Subinterfaces:

CalendarResource, CommentableContent, ModelAwareJCRAmetysObject, ModifiableCalendar, ModifiableCalendarEvent, ModifiableContent, ModifiableWebContent, ModifiableWorkflowAwareContent, ProgramPart, Task, TasksList, TraversableProgramPart

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Cart, Catalog, Container, ContentBackupAmetysObject, Course, CourseList, CoursePart, JCRCalendar, JCRCalendarEvent, JCRCalendarResource, JCRTask, JCRTasksList, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, Query, Site, SubProgram

public interface ModifiableModelAwareDataAwareAmetysObject
extends ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder, ModifiableAmetysObject

Model aware AmetysObject that can handle modifiable data.

Field Summary

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Method Summary

Modifier and Type	Method	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 ModifiableModelAwareComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
default ModifiableModelAwareComposite	getExternalComposite(String compositePath, boolean createNew)	Retrieves the external composite at the given path
default ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
default ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath, boolean createNew)	Retrieves the external repeater at the given path
default ModifiableModelAwareComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
default ModifiableModelAwareComposite	getLocalComposite(String compositePath, boolean createNew)	Retrieves the local composite at the given path
default ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
default ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath, boolean createNew)	Retrieves the local repeater at the given path
default Optional<? extends ModifiableModelAwareDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
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 ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
default ModifiableModelAwareDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default void	removeExternalizableMetadataIfExists(String dataPath)	Removes the stored metadata (status and alternative value) for externalizable (or ex-externalizable) data
default void	removeExternalValue(String dataPath)	Removes the external value of the data at the given path
default void	removeLocalValue(String dataPath)	Removes the local value of the data at the given path
default void	removeValue(String dataPath)	Removes the stored value of the data at the given path
default void	setComments(String dataName, List<DataComment> comments)	Set the comments of the data with the given name
default void	setExternalValue(String dataPath, Object externalValue)	Sets the external value of the data at the given path
default void	setLocalValue(String dataPath, Object localValue)	Sets the local value of the data at the given path
default void	setStatus(String dataPath, ExternalizableDataProvider.ExternalizableDataStatus status)	Set the status 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 <T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones
default <T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ones
default <T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values)	Synchronizes the given values with the current ones
default <T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ModifiableModelAwareDataHolder's 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, dataToSAX, dataToSAX

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

getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty

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

commentsToSAX, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getType, getValue, hasValue, hasValueOrEmpty, isMultiple

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

needsSave, rename, revertChanges, saveChanges

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 DataAwareAmetysObject

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 or is empty

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

getLocalComposite

default ModifiableModelAwareComposite getLocalComposite(String compositePath)
                                                 throws IllegalArgumentException,
                                                        UndefinedItemPathException,
                                                        BadItemTypeException,
                                                        BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface ModelAwareDataAwareAmetysObject

Specified by:

getLocalComposite in interface ModelAwareDataHolder

Specified by:

getLocalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable 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

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

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

getExternalComposite

default ModifiableModelAwareComposite getExternalComposite(String compositePath)
                                                    throws IllegalArgumentException,
                                                           UndefinedItemPathException,
                                                           BadItemTypeException,
                                                           BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface ModelAwareDataAwareAmetysObject

Specified by:

getExternalComposite in interface ModelAwareDataHolder

Specified by:

getExternalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable 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

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

BadItemTypeException - if the stored value 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: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModelAwareDataAwareAmetysObject

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists or is empty

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

getLocalRepeater

default ModifiableModelAwareRepeater getLocalRepeater(String repeaterPath)
                                               throws IllegalArgumentException,
                                                      UndefinedItemPathException,
                                                      BadItemTypeException,
                                                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModelAwareDataAwareAmetysObject

Specified by:

getLocalRepeater in interface ModelAwareDataHolder

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

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

getExternalRepeater

default ModifiableModelAwareRepeater getExternalRepeater(String repeaterPath)
                                                  throws IllegalArgumentException,
                                                         UndefinedItemPathException,
                                                         BadItemTypeException,
                                                         BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModelAwareDataAwareAmetysObject

Specified by:

getExternalRepeater in interface ModelAwareDataHolder

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

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 stored value 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 or null if createNew is false and value not exists or is empty

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

getLocalComposite

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable 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

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

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

getExternalComposite

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable 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

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

BadItemTypeException - if the stored value 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 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 or null if createNew is false and value not exists or is empty

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

getLocalRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

the repeater or null if createNew is false and value not exists or is empty

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

getExternalRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

the repeater or null if createNew is false and value not exists or is empty

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

synchronizeValues

default <T extends SynchronizationResult> T synchronizeValues(Map<String,Object> values)
                                                       throws UndefinedItemPathException,
                                                              BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

synchronizeValues

default <T extends SynchronizationResult> T synchronizeValues(Map<String,Object> values,
                                                              SynchronizationContext context)
                                                       throws UndefinedItemPathException,
                                                              BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

synchronizeValues

default <T extends SynchronizationResult> T synchronizeValues(ViewItemContainer viewItemContainer,
                                                              Map<String,Object> values)
                                                       throws UndefinedItemPathException,
                                                              BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

synchronizeValues

default <T extends SynchronizationResult> T synchronizeValues(ViewItemContainer viewItemContainer,
                                                              Map<String,Object> values,
                                                              SynchronizationContext context)
                                                       throws UndefinedItemPathException,
                                                              BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

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. Give null to empty the value.

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

setLocalValue

default void setLocalValue(String dataPath,
                           Object localValue)
                    throws IllegalArgumentException,
                           UndefinedItemPathException,
                           BadItemTypeException,
                           BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Sets the local value of the data at the given path

Specified by:

setLocalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

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

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

setExternalValue

default void setExternalValue(String dataPath,
                              Object externalValue)
                       throws IllegalArgumentException,
                              UndefinedItemPathException,
                              BadItemTypeException,
                              BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Sets the external value of the data at the given path

Specified by:

setExternalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

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

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

setStatus

default void setStatus(String dataPath,
                       ExternalizableDataProvider.ExternalizableDataStatus status)
                throws IllegalArgumentException,
                       UndefinedItemPathException,
                       BadItemTypeException,
                       BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Set the status of the data at the given path

Specified by:

setStatus in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

status - the new status

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 there is a type issue while getting the parent (part of the dataPath without the last segment)

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

setComments

default void setComments(String dataName,
                         List<DataComment> comments)
                  throws IllegalArgumentException,
                         UndefinedItemPathException

Description copied from interface: ModifiableModelAwareDataHolder

Set the comments of the data with the given name

Specified by:

setComments in interface ModifiableModelAwareDataHolder

Parameters:

dataName - name of the data

comments - the comments to set

Throws:

IllegalArgumentException - if the given data name is null or empty

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

removeValue

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

Description copied from interface: ModifiableModelAwareDataHolder

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

UnknownDataException

removeLocalValue

default void removeLocalValue(String dataPath)
                       throws IllegalArgumentException,
                              UndefinedItemPathException,
                              UnknownDataException,
                              BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Removes the local value of the data at the given path

Specified by:

removeLocalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable 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

UnknownDataException

removeExternalValue

default void removeExternalValue(String dataPath)
                          throws IllegalArgumentException,
                                 UndefinedItemPathException,
                                 UnknownDataException,
                                 BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Removes the external value of the data at the given path

Specified by:

removeExternalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable 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

UnknownDataException

removeExternalizableMetadataIfExists

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

Description copied from interface: ModifiableModelAwareDataHolder

Removes the stored metadata (status and alternative value) for externalizable (or ex-externalizable) data

Specified by:

removeExternalizableMetadataIfExists in interface ModifiableModelAwareDataHolder

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

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

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

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Specified by:

getParentDataHolder in interface ModifiableModelAwareDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

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

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Specified by:

getRootDataHolder in interface ModifiableModelAwareDataHolder

Returns:

the root DataHolder