Package org.ametys.cms.data.ametysobject

Interface IndexableAmetysObject

All Superinterfaces:

AmetysObject, DataHolder, IndexableDataHolder, ModelAwareAmetysObject, ModelAwareDataHolder

All Known Subinterfaces:

CalendarEvent, CalendarResource, CommentableContent, Content, ContributorCommentableContent, IndexableJCRAmetysObject, ModifiableCalendarEvent, ModifiableContent, ModifiableIndexableAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, ProgramPart, SharedContent, Task, TasksList, Thread, TraversableProgramPart, WebContent, WorkflowAwareContent

All Known Implementing Classes:

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

public interface IndexableAmetysObject
extends ModelAwareAmetysObject, IndexableDataHolder

Model aware AmetysObject that can handle indexable data.

Field Summary

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Method Summary

Modifier and Type	Method	Description
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
List<org.apache.solr.common.SolrInputDocument>	indexData(org.apache.solr.common.SolrInputDocument document, CMSDataContext 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.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.cms.data.holder.IndexableDataHolder

getComposite, getExternalComposite, getExternalRepeater, getLocalComposite, getLocalRepeater, getParentDataHolder, getRepeater, getRootDataHolder

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

getModel

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

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModelItemTypeExtensionPoint, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, isMultiple, isMultiple

Method Details

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

List<org.apache.solr.common.SolrInputDocument> indexData(org.apache.solr.common.SolrInputDocument document,
 CMSDataContext 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