Interface SearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
QueryInspector	getQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
SearchResultsRecord	getSearchResultsRecord(Type searchRecordType)	Gets the search results record corresponding to the given search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidSearchResults

getResultSize

Method Details

getQueryInspector

QueryInspector getQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getSearchResultsRecord

SearchResultsRecord getSearchResultsRecord(Type searchRecordType)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

searchRecordType - a search record type

Returns:

the search results record

Throws:

NullArgumentException - searchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(searchRecordType) is false

Compliance:

mandatory - This method must be implemented.