Interface CatalogEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CatalogEnablerSearch
extends OsidSearch

The search interface for governing catalog enabler searches.

Method Summary

Modifier and Type	Method	Description
CatalogEnablerSearchRecord	getCatalogEnablerSearchRecord(Type catalogEnablerSearchRecordType)	Gets the catalog enabler search record corresponding to the given catalog enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCatalogEnablerResults(CatalogEnablerSearchOrder catalogEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongCatalogEnablers(IdList catalogEnablerIds)	Execute this search among the given list of catalog enablers.

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

searchAmongCatalogEnablers

void searchAmongCatalogEnablers(IdList catalogEnablerIds)

Execute this search among the given list of catalog enablers.

Parameters:

catalogEnablerIds - list of catalog enablers

Throws:

NullArgumentException - catalogEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderCatalogEnablerResults

void orderCatalogEnablerResults(CatalogEnablerSearchOrder catalogEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

catalogEnablerSearchOrder - catalog enabler search order

Throws:

NullArgumentException - catalogEnablerSearchOrder is null

UnsupportedException - catalogEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerSearchRecord

CatalogEnablerSearchRecord getCatalogEnablerSearchRecord(Type catalogEnablerSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

catalogEnablerSearchRecordType - a catalog enabler search record type

Returns:

the catalog enabler search record

Throws:

NullArgumentException - catalogEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.