Interface RelevancySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RelevancySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
RelevancyList	getRelevancies()	Gets the relevancy list resulting from the search.
RelevancyQueryInspector	getRelevancyQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RelevancySearchResultsRecord	getRelevancySearchResultsRecord(Type relevancySearchRecordType)	Gets the relevancy search results record corresponding to the given relevancy search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getRelevancies

RelevancyList getRelevancies()

Gets the relevancy list resulting from the search.

Returns:

the relevancy list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRelevancyQueryInspector

RelevancyQueryInspector getRelevancyQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the relevancy query inspector

Compliance:

mandatory - This method must be implemented.

getRelevancySearchResultsRecord

RelevancySearchResultsRecord getRelevancySearchResultsRecord(Type relevancySearchRecordType)
                                                      throws OperationFailedException

Gets the relevancy search results record corresponding to the given relevancy search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

relevancySearchRecordType - a relevancy search record type

Returns:

the relevancy search results record

Throws:

NullArgumentException - relevancySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.