Package org.ametys.cms.data.holder

Interface IndexableDataHolder

All Superinterfaces:

DataHolder, ModelAwareDataHolder

All Known Subinterfaces:

CalendarResource, CommentableContent, Content, IndexableComposite, IndexableRepeaterEntry, ModelAwareDataAwareAmetysObject, ModelAwareJCRAmetysObject, ModifiableCalendar, ModifiableCalendarEvent, ModifiableContent, ModifiableIndexableComposite, ModifiableIndexableDataHolder, ModifiableIndexableRepeaterEntry, ModifiableModelAwareDataAwareAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, SharedContent, Task, TasksList, WebContent, WorkflowAwareContent

All Known Implementing Classes:

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

public interface IndexableDataHolder
extends ModelAwareDataHolder

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

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

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData

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, getExternalValue, getLocalValue, getModel, getStatus, getType, getValue, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty, isMultiple

Method Details

getComposite

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

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

IndexableComposite 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

IndexableComposite 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

IndexableRepeater 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

IndexableRepeater 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

IndexableRepeater 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

getParentDataHolder

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

Returns:

the parent of the current DataHolder

getRootDataHolder

IndexableDataHolder 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

Returns:

the root DataHolder