Package org.ametys.cms.data.ametysobject

Interface ModelAwareDataAwareAmetysObject

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, IndexableDataHolder, ModelAwareDataAwareAmetysObject, ModelAwareDataHolder

All Known Subinterfaces:

CalendarResource, CommentableContent, Content, ContributorCommentableContent, ModelAwareJCRAmetysObject, ModifiableCalendar, ModifiableCalendarEvent, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, SharedContent, Task, TasksList, Thread, WebContent, WorkflowAwareContent

All Known Implementing Classes:

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

public interface ModelAwareDataAwareAmetysObject
extends ModelAwareDataAwareAmetysObject, IndexableDataHolder

Model aware AmetysObject that can handle indexable data.

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
default IndexableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
IndexableDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
default IndexableComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
default IndexableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
default IndexableComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
default IndexableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
default Optional<? extends IndexableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
default IndexableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
default IndexableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default Optional<SystemPropertyExtensionPoint>	getSystemPropertyExtensionPoint()	Retrieves the system properties extension point of this AmetysObject, or an empty Optional if this object does not support system properties
default List<org.apache.solr.common.SolrInputDocument>	indexData(org.apache.solr.common.SolrInputDocument document)	Indexes all data and properties of this AmetysObject
default List<org.apache.solr.common.SolrInputDocument>	indexData(org.apache.solr.common.SolrInputDocument document, IndexableDataContext context)	Indexes all data and properties of this AmetysObject

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareDataAwareAmetysObject

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

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

commentsToSAX, dataToJSON, dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, getDataNames, getType, getValue, hasValue, hasValueOrEmpty, isMultiple

Method Details

getDataHolder

IndexableDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelAwareDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getSystemPropertyExtensionPoint

default Optional<SystemPropertyExtensionPoint> getSystemPropertyExtensionPoint()

Retrieves the system properties extension point of this AmetysObject, or an empty Optional if this object does not support system properties

Returns:

the system properties extension point of this AmetysObject

indexData

default List<org.apache.solr.common.SolrInputDocument> indexData(org.apache.solr.common.SolrInputDocument document)
                                                          throws BadItemTypeException

Indexes all data and properties of this AmetysObject

Parameters:

document - the solr document representing this AmetysObject

Returns:

additional solr documents that may have been created (ex: repeater entries)

Throws:

BadItemTypeException - if the saxed value's type does not matches the stored data

indexData

default List<org.apache.solr.common.SolrInputDocument> indexData(org.apache.solr.common.SolrInputDocument document,
 IndexableDataContext context)
                                                          throws BadItemTypeException

Indexes all data and properties of this AmetysObject

Parameters:

document - the solr document representing this AmetysObject

context - The context of the data to index

Returns:

additional solr documents that may have been created (ex: repeater entries)

Throws:

BadItemTypeException - if the saxed value's type does not matches the stored data

getComposite

default IndexableComposite 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 DataAwareAmetysObject

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface IndexableDataHolder

Specified by:

getComposite in interface ModelAwareDataAwareAmetysObject

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

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

Specified by:

getLocalComposite in interface ModelAwareDataAwareAmetysObject

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

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

Specified by:

getExternalComposite in interface ModelAwareDataAwareAmetysObject

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

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

Specified by:

getRepeater in interface ModelAwareDataAwareAmetysObject

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

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

Specified by:

getLocalRepeater in interface ModelAwareDataAwareAmetysObject

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

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

Specified by:

getExternalRepeater in interface ModelAwareDataAwareAmetysObject

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

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

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface IndexableDataHolder

Specified by:

getParentDataHolder in interface ModelAwareDataAwareAmetysObject

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

default IndexableDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataAwareAmetysObject

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface IndexableDataHolder

Specified by:

getRootDataHolder in interface ModelAwareDataAwareAmetysObject

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Returns:

the root DataHolder