Interface RepositorySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RepositorySearch
extends OsidSearch

The interface for governing repository searches.

Method Summary

Modifier and Type	Method	Description
RepositorySearchRecord	getRepositorySearchRecord(Type repositorySearchRecordType)	Gets the repository search record corresponding to the given repository search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRepositoryResults(RepositorySearchOrder repositorySearchOrder)	Specify an ordering to the search results.
void	searchAmongRepositories(IdList repositoryIds)	Execute this search among the given list of repositories.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongRepositories

void searchAmongRepositories(IdList repositoryIds)

Execute this search among the given list of repositories.

Parameters:

repositoryIds - list of repositories

Throws:

NullArgumentException - repositoryIds is null

Compliance:

mandatory - This method must be implemented.

orderRepositoryResults

void orderRepositoryResults(RepositorySearchOrder repositorySearchOrder)

Specify an ordering to the search results.

Parameters:

repositorySearchOrder - repository search order

Throws:

NullArgumentException - repositorySearchOrder is null

UnsupportedException - repositorySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRepositorySearchRecord

RepositorySearchRecord getRepositorySearchRecord(Type repositorySearchRecordType)
                                          throws OperationFailedException

Gets the repository search 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 record

Throws:

NullArgumentException - repositorySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(repositorySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.