Package org.ametys.plugins.repository.data.holder

Interface ModifiableModelAwareDataHolder

All Superinterfaces:

DataHolder, ModelAwareDataHolder, ModifiableDataHolder

All Known Subinterfaces:

CommentableContent, ModelAwareJCRAmetysObject, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, ProgramPart, TraversableProgramPart

All Known Implementing Classes:

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

public interface ModifiableModelAwareDataHolder
extends ModifiableDataHolder, ModelAwareDataHolder

Interface for modifiable data containers with models

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
ModifiableModelAwareComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
ModifiableModelAwareComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
ModifiableModelAwareComposite	getExternalComposite(String compositePath, boolean createNew)	Retrieves the external composite at the given path
ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath, boolean createNew)	Retrieves the external repeater at the given path
ModifiableModelAwareComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
ModifiableModelAwareComposite	getLocalComposite(String compositePath, boolean createNew)	Retrieves the local composite at the given path
ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath, boolean createNew)	Retrieves the local repeater at the given path
Optional<? extends ModifiableModelAwareDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModifiableModelAwareRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath, boolean createNew)	Retrieves the repeater at the given path
ModifiableModelAwareDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
void	removeExternalValue(String dataPath)	Removes the external value of the data at the given path
void	removeLocalValue(String dataPath)	Removes the local value of the data at the given path
void	removeValue(String dataPath)	Removes the stored value of the data at the given path
void	setComments(String dataName, List<DataComment> comments)	Set the comments of the data with the given name
void	setExternalValue(String dataPath, Object externalValue)	Sets the external value of the data at the given path
void	setLocalValue(String dataPath, Object localValue)	Sets the local value of the data at the given path
void	setStatus(String dataPath, ExternalizableDataProvider.ExternalizableDataStatus status)	Set the status of the data at the given path
void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values)	Synchronizes the given values with the current ones
<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.data.holder.DataHolder

copyTo, dataToSAX, dataToSAX

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

commentsToSAX, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getType, getValue, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasLocalValue, hasNonEmptyExternalValue, hasNonEmptyLocalValue, hasNonEmptyValue, hasValue, isMultiple

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

getRepositoryData

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

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 ModelAwareDataHolder

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

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 ModelAwareDataHolder

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

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 ModelAwareDataHolder

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

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 ModelAwareDataHolder

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

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 ModelAwareDataHolder

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

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

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

getLocalComposite

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

Retrieves the local composite at the given path

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

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

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

getExternalComposite

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

Retrieves the external composite at the given path

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

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

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

getRepeater

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

Retrieves the repeater at the given path

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

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

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

getLocalRepeater

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

Retrieves the local repeater at the given path

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

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

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

getExternalRepeater

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

Retrieves the external repeater at the given path

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

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

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

synchronizeValues

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

Synchronizes the given values with the current ones

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

IOException - if an error occurs while synchronizing I/O data

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

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

Synchronizes the given values with the current ones

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

IOException - if an error occurs while synchronizing I/O data

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

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

Synchronizes the given values with the current ones

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:

IOException - if an error occurs while synchronizing I/O data

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

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

Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones

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

IOException - if an error occurs while synchronizing I/O data

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

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

Sets the local value of the data at the given path

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

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

Sets the external value of the data at the given path

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

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

Set the status of the data at the given path

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

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

Set the comments of the data with the given name

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

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

Removes the stored value of the data 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 - if the value of the parent of the given path is not an item container

removeLocalValue

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

Removes the local value of the data at the given path

Parameters:

dataPath - path of the externalizable data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

BadItemTypeException - if the value of the parent of the given path is not an item container

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

removeExternalValue

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

Removes the external value of the data at the given path

Parameters:

dataPath - path of the externalizable data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

BadItemTypeException - if the value of the parent of the given path is not an item container

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

getParentDataHolder

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 DataHolder

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

ModifiableModelAwareDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Returns:

the root DataHolder