org.osid.repository

Interface RepositorySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RepositorySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
RepositoryList	getRepositories() Gets the repository list resulting from the search.
RepositoryQueryInspector	getRepositoryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
RepositorySearchResultsRecord	getRepositorySearchResultsRecord(Type repositorySearchRecordType) Gets the repository search results record corresponding to the given repository search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getRepositories

RepositoryList getRepositories()

Gets the repository list resulting from the search.

Returns:

the repository list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRepositoryQueryInspector

RepositoryQueryInspector getRepositoryQueryInspector()

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.

getRepositorySearchResultsRecord

RepositorySearchResultsRecord getRepositorySearchResultsRecord(Type repositorySearchRecordType)
                                                               throws OperationFailedException

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

Parameters:

repositorySearchRecordType - a repository search record type

Returns:

the repository search results record

Throws:

NullArgumentException - repositorySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(repositorySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.