Interface CourseOfferingSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CourseOfferingSearch
extends OsidSearch

The search interface for governing course offering searches.

Method Summary

Modifier and Type	Method	Description
CourseOfferingSearchRecord	getCourseOfferingSearchRecord(Type courseOfferingSearchRecordType)	Gets the course offering search record corresponding to the given course offering search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCourseOfferingResults(CourseOfferingSearchOrder courseOfferingSearchOrder)	Specify an ordering to the search results.
void	searchAmongCourseOfferings(IdList courseOfferingIds)	Execute this search among the given list of course offerings.

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

searchAmongCourseOfferings

void searchAmongCourseOfferings(IdList courseOfferingIds)

Execute this search among the given list of course offerings.

Parameters:

courseOfferingIds - list of courses

Throws:

NullArgumentException - courseOfferingIds is null

Compliance:

mandatory - This method must be implemented.

orderCourseOfferingResults

void orderCourseOfferingResults(CourseOfferingSearchOrder courseOfferingSearchOrder)

Specify an ordering to the search results.

Parameters:

courseOfferingSearchOrder - course search order

Throws:

NullArgumentException - courseOfferingSearchOrder is null

UnsupportedException - courseOfferingSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseOfferingSearchRecord

CourseOfferingSearchRecord getCourseOfferingSearchRecord(Type courseOfferingSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

courseOfferingSearchRecordType - a course search record type

Returns:

the course offering search record

Throws:

NullArgumentException - courseOfferingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseOfferingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.