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

Interface ModifiableDataHolder

All Superinterfaces:

DataHolder

All Known Subinterfaces:

CommentableContent, ModelAwareJCRAmetysObject, ModelLessJCRAmetysObject, ModifiableComposite, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder, ModifiableModelLessDataAwareAmetysObject, ModifiableModelLessDataHolder, ModifiablePage, ModifiableRepeaterEntry, ModifiableWebContent, ModifiableWorkflowAwareContent, ModifiableZone, ModifiableZoneItem, ProgramPart, TraversableProgramPart

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractSurveyElement, AbstractTraversableProgramPart, Catalog, Container, ContentBackupAmetysObject, ContentValue, Course, CourseList, CoursePart, DefaultLink, DefaultModifiableModelAwareDataHolder, DefaultModifiableModelLessDataHolder, DefaultPage, DefaultZone, DefaultZoneItem, JCRProjectMember, ModifiableContentDataHolder, ModifiableDefaultContent, ModifiableDefaultWebContent, ModifiableModelAwareComposite, ModifiableModelAwareRepeaterEntry, ModifiableModelLessComposite, OrgUnit, Person, Program, Project, Site, Sitemap, SubProgram, Survey, SurveyPage, SurveyQuestion

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

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

copyTo, dataToSAX, dataToSAX, getDataNames, hasNonEmptyValue, hasValue

Method Details

getComposite

ModifiableComposite getComposite(String compositePath)
                          throws IllegalArgumentException,
BadItemTypeException

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

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

getComposite

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

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

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

removeValue

void removeValue(String dataPath)
          throws IllegalArgumentException,
UnknownDataException,
BadItemTypeException

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

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

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

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