com.sapportals.wcm.service.indexmanagement.retrieval.search
Interface ISearchResult

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]

public interface ISearchResult

Represents a document in the search result.

Method Summary

void	addLocalProperty(IProperty property) Adds a new local property.
java.lang.String	getContentSnippet() Returns the content snippet.
IPropertyMap	getLocalProperties() Return the local properties, including the content snippet.
float	getRankValue() Specifies how good the result document fits to the search query.
IResource	getResource()
java.lang.String	getResultLanguage() Document language if it was returned with the search result.
void	setContentSnippet(java.lang.String contentSnippet) Sets the content snippet.
void	setLocalProperties(IPropertyMap propertyMap) Sets the local properties.
void	setResultLanguage(java.lang.String language) Sets the document language.

Method Detail

getResource

public IResource getResource()

Returns:

resource - document that has been found

getRankValue

public float getRankValue()

Specifies how good the result document fits to the search query.

Returns:

rank value of taxonomy class folder (between 0.0 and 1.0)

getResultLanguage

public java.lang.String getResultLanguage()

Document language if it was returned with the search result. null if not available.

Returns:

document language

setResultLanguage

public void setResultLanguage(java.lang.String language)

Sets the document language.

Parameters:

document - language

setContentSnippet

public void setContentSnippet(java.lang.String contentSnippet)
                       throws ResourceException

Sets the content snippet. The content snippet is also part of the local properties.

Parameters:

contentSnippet -

Throws:

ResourceException - in case of a failure.

getContentSnippet

public java.lang.String getContentSnippet()
                                   throws ResourceException

Returns the content snippet. null if not available.

Returns:

content snippet

Throws:

ResourceException - in case of a failure.

setLocalProperties

public void setLocalProperties(IPropertyMap propertyMap)

Sets the local properties. All old local properties are deleted, including the content snippet.

Parameters:

propertyMap - which contains new local properties.

getLocalProperties

public IPropertyMap getLocalProperties()

Return the local properties, including the content snippet.

Returns:

propertyMap which contains new local properties.

addLocalProperty

public void addLocalProperty(IProperty property)

Adds a new local property. If an old property with the same name exists that property is replaced.

Parameters:

property - the new property