Package org.ametys.cms.data.holder

Interface ModifiableIndexableDataHolder

All Superinterfaces:

DataHolder, IndexableDataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

All Known Subinterfaces:

CalendarResource, CommentableContent, ContributorCommentableContent, ModelAwareJCRAmetysObject, ModifiableCalendar, ModifiableCalendarEvent, ModifiableContent, ModifiableIndexableComposite, ModifiableIndexableRepeaterEntry, ModifiableModelAwareDataAwareAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, SharedContent, Task, TasksList, Thread

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Cart, Catalog, Container, ContentBackupAmetysObject, Course, CourseList, CoursePart, DefaultModifiableModelAwareComposite, DefaultModifiableModelAwareDataHolder, DefaultModifiableModelAwareRepeaterEntry, DefaultSharedContent, Form, FormEntry, FormPageRule, FormQuestion, JCRCalendar, JCRCalendarEvent, JCRCalendarResource, JCRTask, JCRTasksList, JCRThread, ModifiableContentDataHolder, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, Query, Site, SubProgram

public interface ModifiableIndexableDataHolder
extends IndexableDataHolder, ModifiableModelAwareDataHolder

Interface for modifiable and indexable data containers

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
ModifiableIndexableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableIndexableComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
ModifiableIndexableComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
ModifiableIndexableComposite	getExternalComposite(String compositePath, boolean createNew)	Retrieves the external composite at the given path
ModifiableIndexableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
ModifiableIndexableRepeater	getExternalRepeater(String repeaterPath, boolean createNew)	Retrieves the external repeater at the given path
ModifiableIndexableComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
ModifiableIndexableComposite	getLocalComposite(String compositePath, boolean createNew)	Retrieves the local composite at the given path
ModifiableIndexableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
ModifiableIndexableRepeater	getLocalRepeater(String repeaterPath, boolean createNew)	Retrieves the local repeater at the given path
Optional<? extends ModifiableIndexableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModifiableIndexableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ModifiableIndexableRepeater	getRepeater(String repeaterPath, boolean createNew)	Retrieves the repeater at the given path
ModifiableIndexableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX

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

commentsToSAX, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getStatus, getType, getValue, getValue, getValue, hasComments, hasDefinition, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty, isMultiple

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

getRepositoryData

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

removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setComments, setExternalValue, setLocalValue, setStatus, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

Method Details

getComposite

ModifiableIndexableComposite getComposite(String compositePath)
                                   throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface IndexableDataHolder

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

getComposite

ModifiableIndexableComposite 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

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

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

getLocalComposite

ModifiableIndexableComposite 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

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

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

getExternalComposite

ModifiableIndexableComposite 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

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

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

getRepeater

ModifiableIndexableRepeater 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

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

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

getLocalRepeater

ModifiableIndexableRepeater 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

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

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

getExternalRepeater

ModifiableIndexableRepeater 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

getParentDataHolder

Optional<? extends ModifiableIndexableDataHolder> 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 IndexableDataHolder

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

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

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Specified by:

getRootDataHolder in interface ModifiableModelAwareDataHolder

Returns:

the root DataHolder