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

Interface ModifiableDataHolder

All Superinterfaces:

DataHolder

All Known Subinterfaces:

CalendarResource, CommentableContent, ContributorCommentableContent, IndexableJCRAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, LockablePage, ModelAwareJCRAmetysObject, ModifiableAmetysObject, ModifiableCalendarEvent, ModifiableComposite, ModifiableContent, ModifiableDataAwareVersionableAmetysObject, ModifiableDublinCoreAwareAmetysObject, ModifiableExplorerNode, ModifiableIndexableAmetysObject, ModifiableIndexableComposite, ModifiableIndexableDataHolder, ModifiableIndexableRepeaterEntry, ModifiableMetadataAwareAmetysObject, ModifiableModelAwareAmetysObject, ModifiableModelAwareComposite, ModifiableModelAwareDataHolder, ModifiablePage, ModifiableRepeaterEntry, ModifiableResource, ModifiableResourceCollection, ModifiableSitemapElement, ModifiableTraversableAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, ModifiableZone, ModifiableZoneItem, ProgramPart, SharedContent, Task, TasksList, Thread, TrashableAmetysObject, TrashElement, TraversableProgramPart, WorkflowAwareAmetysObject, WorkflowAwareContent

All Known Implementing Classes:

AbstractColorableJCRTag, AbstractProgram, AbstractProgramPart, AbstractSitemapElement, AbstractSurveyElement, AbstractTraversableProgramPart, Activity, AmetysObjectCollection, CacheContentVersionChunk, Cart, CartContainer, Catalog, CategoryJCR, CMISRootResourcesCollection, CMSJCRTag, Container, ContentBackupAmetysObject, ContentConsistencyResult, ContentValue, Course, CourseList, CoursePart, DefaultAlias, DefaultAmetysObject, DefaultContent, DefaultDefinition, DefaultIndexableAmetysObject, DefaultIndexableTraversableAmetysObject, DefaultLink, DefaultLockableAmetysObject, DefaultModifiableComposite, DefaultModifiableDataHolder, DefaultModifiableIndexableComposite, DefaultModifiableIndexableDataHolder, DefaultModifiableIndexableRepeaterEntry, DefaultModifiableModelAwareComposite, DefaultModifiableModelAwareDataHolder, DefaultModifiableRepeaterEntry, DefaultPage, DefaultSharedContent, DefaultTheme, DefaultTheme, DefaultTrashElement, DefaultTraversableAmetysObject, DefaultWebContent, DefaultWorkflowAwareContent, DefaultZone, DefaultZoneItem, File, Folder, Form, FormDirectory, FormEntry, FormPage, FormPageRule, FormQuestion, JCRCalendar, JCRCalendarEvent, JCRCalendarResource, JCRCategory, JCRProjectMember, JCRResource, JCRResourcesCollection, JCRTag, JCRTask, JCRTasksList, JCRThread, KeywordJCR, ModifiableContentDataHolder, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, Project, ProjectTagJCR, Query, QueryContainer, RootAmetysObject, SimpleAmetysObject, SimpleIndexableAmetysObject, SimpleModelAwareAmetysObject, Site, Sitemap, SubProgram, Subscription, Survey, SurveyPage, SurveyQuestion, ThemeJCR, ThemeJCR, Thesaurus, VersionAmetysObject, VersionComponentAmetysObject, VersionsAmetysObject

public interface ModifiableDataHolder
extends DataHolder

Interface for modifiable data containers

Method Summary

Modifier and Type	Method	Description
ModifiableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
Optional<? extends ModifiableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModifiableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
void	removeValue(String dataPath)	Removes the stored value of the data 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
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Method Details

getComposite

ModifiableComposite getComposite(String compositePath)
                          throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

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

UnknownTypeException - if the type composite is not available for this data holder

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

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

getComposite

ModifiableComposite getComposite(String compositePath,
 boolean createNew)
                          throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Retrieves the composite at the given path

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

UnknownTypeException - if the type composite is not available for this data holder

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and 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 UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException

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:

UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point

BadItemTypeException - if type of the a data doesn't match the corresponding given value to set

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

setValue

void setValue(String dataPath,
 Object value)
       throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Sets the value of the data at the given path

Parameters:

dataPath - path of the data

value - the value to set. To empty a value, use setValue(String, Object, String) with a null value

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given the data path is composed of an non existing group

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

BadItemTypeException - if type of the data at the given path doesn't match the given value to set

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the model

BadDataPathCardinalityException - if the data holder has a model and the definition 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,
UnknownDataException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
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.

dataTypeId - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given data path is composed of an non existing group

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the model

BadDataPathCardinalityException - if the data holder has a model and 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,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Removes the stored value of the data at the given path

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the the data to remove is in a group and there is no available type compatible with this group

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the model

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

getRepositoryData

ModifiableRepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Returns:

the repository data used by this DataHolder

getParentDataHolder

Optional<? extends ModifiableDataHolder> 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

Returns:

the parent of the current DataHolder

getRootDataHolder

ModifiableDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Returns:

the root DataHolder