oracle.ecsf
Interface IndexedDocument

All Superinterfaces:

Document

public interface IndexedDocument
extends Document

The IndexedDocument class wraps a search hit. It is returned to caller via @see SearchHits.

Method Summary

SearchAction[]	getActions() Returns all actions available for this document.
java.util.Collection<AttributeValue>	getAttributeValues() Returns a list of attribute values, type of AttributeValue
SearchAction	getDefaultAction() Returns default action for this document.
java.lang.String	getDescription() A short description of this document.
int	getScore() Returns Score for this document
void	overrideActions(SearchAction[] actions) The plugin can call this method to override default action.

Methods inherited from interface oracle.ecsf.Document

addChildDoc, addField, addTags, clearTags, getAttributes, getChildDocs, getContent, getContentType, getDisplayURL, getDocumentDefinition, getFields, getFieldValue, getKeywords, getLanguage, getPrimaryKey, getSearchableObject, getTags, getTitle, removeChildDocs, setContent, setContentType, setDocumentDefinition, setFieldValue, setKeywords, setLanguage, setPrimaryKey, setTitle

Method Detail

overrideActions

void overrideActions(SearchAction[] actions)

The plugin can call this method to override default action.

Parameters:

action - overriding search action.

See Also:

SearchAction

getDefaultAction

SearchAction getDefaultAction()

Returns default action for this document.

Returns:

default search action.

See Also:

SearchAction

getDescription

java.lang.String getDescription()

A short description of this document.

Returns:

a short description.

getActions

SearchAction[] getActions()

Returns all actions available for this document.

Returns:

search actions.

See Also:

SearchAction

getAttributeValues

java.util.Collection<AttributeValue> getAttributeValues()

Returns a list of attribute values, type of AttributeValue

Returns:

list of attribute values.

getScore

int getScore()

Returns Score for this document

Returns:

relevance Score.