lumis.doui.search.common
Interface ISearchable

All Known Implementing Classes:

DocumentDataType.Data, FileDataType.Data, FilesDataType.Data, HtmlDataType.Data, ImageDataType.Data

@StableMinor(version="5.5",
             sinceVersion="4.2.2")
public interface ISearchable

Interface to be implemented by data objects that may be indexed and searched.

Since:

4.2.2

Method Summary

Collection<SearchContentAttachment>	getSearchContentAttachments() Returns the search content attachments to be used for indexing this object.
List<SearchContentField>	getSearchContentFields() Returns the search content fields to be used for indexing this object.

Method Detail

getSearchContentFields

List<SearchContentField> getSearchContentFields()

Returns the search content fields to be used for indexing this object.

Note that the actual search content fields used are decided by the ISourceSearchContentFiller implementation used in the source. It may or may not use the fields returned by this method. This method provides only the default recommended search fields for this data.

Returns:

the search content fields. Never returns null. May return an empty collection if no field is to be used for indexing this object.

Since:

4.2.2

getSearchContentAttachments

Collection<SearchContentAttachment> getSearchContentAttachments()

Returns the search content attachments to be used for indexing this object.

Must never return null. May return an empty collection if no attachment is to be used for indexing this object.

Returns:

the search content attachments.

Since:

4.2.2