Interface CourseCatalogSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CourseCatalogSearch
extends OsidSearch

The search interface for governing course catalog searches.

Method Summary

Modifier and Type	Method	Description
CourseCatalogSearchRecord	getCourseCatalogSearchRecord(Type courseCatalogSearchRecordType)	Gets the course catalog search record corresponding to the given course catalog search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCourseCatalogResults(CourseCatalogSearchOrder courseCatalogSearchOrder)	Specify an ordering to the search results.
void	searchAmongCourseCatalogs(IdList courseCatalogIds)	Execute this search among the given list of course 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

searchAmongCourseCatalogs

void searchAmongCourseCatalogs(IdList courseCatalogIds)

Execute this search among the given list of course catalogs.

Parameters:

courseCatalogIds - list of course catalogs

Throws:

NullArgumentException - courseCatalogIds is null

Compliance:

mandatory - This method must be implemented.

orderCourseCatalogResults

void orderCourseCatalogResults(CourseCatalogSearchOrder courseCatalogSearchOrder)

Specify an ordering to the search results.

Parameters:

courseCatalogSearchOrder - course catalog search order

Throws:

NullArgumentException - courseCatalogSearchOrder is null

UnsupportedException - courseCatalogSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseCatalogSearchRecord

CourseCatalogSearchRecord getCourseCatalogSearchRecord(Type courseCatalogSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

courseCatalogSearchRecordType - a course catalog search record type

Returns:

the course catalog search record

Throws:

NullArgumentException - courseCatalogSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseCatalogSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.