Interface CatalogueSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CatalogueSearch
extends OsidSearch

The search interface for governing catalogue searches.

Method Summary

Modifier and Type	Method	Description
CatalogueSearchRecord	getCatalogueSearchRecord(Type catalogueSearchRecordType)	Gets the record corresponding to the given catalogue search record Type .
void	orderCatalogueResults(CatalogueSearchOrder catalogueSearchOrder)	Specify an ordering to the search results.
void	searchAmongCatalogues(IdList catalogueIds)	Execute this search among the given list of catalogues.

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

searchAmongCatalogues

void searchAmongCatalogues(IdList catalogueIds)

Execute this search among the given list of catalogues.

Parameters:

catalogueIds - list of catalogues

Throws:

NullArgumentException - catalogueIds is null

Compliance:

mandatory - This method must be implemented.

orderCatalogueResults

void orderCatalogueResults(CatalogueSearchOrder catalogueSearchOrder)

Specify an ordering to the search results.

Parameters:

catalogueSearchOrder - catalogue search order

Throws:

NullArgumentException - catalogueSearchOrder is null

UnsupportedException - catalogueSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCatalogueSearchRecord

CatalogueSearchRecord getCatalogueSearchRecord(Type catalogueSearchRecordType)
                                        throws OperationFailedException

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

Parameters:

catalogueSearchRecordType - a catalogue search record type

Returns:

the catalogue search record

Throws:

NullArgumentException - catalogueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.