Interface CourseRegistrationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CourseRegistrationSearch
extends OsidSearch

The search interface for governing course registration searches.

Method Summary

Modifier and Type	Method	Description
CourseRegistrationSearchRecord	getCourseRegistrationSearchRecord(Type courseRegistrationSearchRecordType)	Gets the course registration search record corresponding to the given course registration search record Type .
void	orderCourseRegistrationResults(CourseRegistrationSearchOrder courseRegistrationSearchOrder)	Specify an ordering to the search results.
void	searchAmongCourseRegistrations(IdList courseRegistrationIds)	Execute this search among the given list of course registrations.

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

searchAmongCourseRegistrations

void searchAmongCourseRegistrations(IdList courseRegistrationIds)

Execute this search among the given list of course registrations.

Parameters:

courseRegistrationIds - list of course registrations

Throws:

NullArgumentException - courseRegistrationIds is null

Compliance:

mandatory - This method must be implemented.

orderCourseRegistrationResults

void orderCourseRegistrationResults(CourseRegistrationSearchOrder courseRegistrationSearchOrder)

Specify an ordering to the search results.

Parameters:

courseRegistrationSearchOrder - course registration search order

Throws:

NullArgumentException - courseRegistrationSearchOrder is null

UnsupportedException - courseRegistrationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseRegistrationSearchRecord

CourseRegistrationSearchRecord getCourseRegistrationSearchRecord(Type courseRegistrationSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

courseRegistrationSearchRecordType - a course registration search record type

Returns:

the course registration search record

Throws:

NullArgumentException - courseRegistrationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseRegistrationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.