Interface CatalogSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CatalogSearch
extends OsidSearch

The search interface for governing the search query for Catalogs.

Method Summary

Modifier and Type	Method	Description
CatalogSearchRecord	getCatalogSearchRecord(Type catalogSearchRecordType)	Gets the catalog search record corresponding to the given catalog search record Type.
void	orderCatalogResults(CatalogSearchOrder catalogSearchOrder)	Specify an ordering to the search results.
void	searchAmongCatalogs(IdList catalogIds)	Execute this search among the given list of catalogs.

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

searchAmongCatalogs

void searchAmongCatalogs(IdList catalogIds)

Execute this search among the given list of catalogs.

Parameters:

catalogIds - list of catalogs

Throws:

NullArgumentException - catalogIds is null

Compliance:

mandatory - This method must be implemented.

orderCatalogResults

void orderCatalogResults(CatalogSearchOrder catalogSearchOrder)

Specify an ordering to the search results.

Parameters:

catalogSearchOrder - catalog search order

Throws:

NullArgumentException - catalogSearchOrder is null

UnsupportedException - catalogSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCatalogSearchRecord

CatalogSearchRecord getCatalogSearchRecord(Type catalogSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

catalogSearchRecordType - a catalog search record type

Returns:

the catalog search record

Throws:

NullArgumentException - catalogSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.