Interface CourseSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CourseSearch
extends OsidSearch

The search interface for governing course searches.

Method Summary

Modifier and Type	Method	Description
CourseSearchRecord	getCourseSearchRecord(Type courseSearchRecordType)	Gets the course search record corresponding to the given course search record Type .
void	orderCourseResults(CourseSearchOrder courseSearchOrder)	Specify an ordering to the search results.
void	searchAmongCourses(IdList courseIds)	Execute this search among the given list of courses.

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

searchAmongCourses

void searchAmongCourses(IdList courseIds)

Execute this search among the given list of courses.

Parameters:

courseIds - list of courses

Throws:

NullArgumentException - courseIds is null

Compliance:

mandatory - This method must be implemented.

orderCourseResults

void orderCourseResults(CourseSearchOrder courseSearchOrder)

Specify an ordering to the search results.

Parameters:

courseSearchOrder - course search order

Throws:

NullArgumentException - courseSearchOrder is null

UnsupportedException - courseSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseSearchRecord

CourseSearchRecord getCourseSearchRecord(Type courseSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

courseSearchRecordType - a course search record type

Returns:

the course search record

Throws:

NullArgumentException - courseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.