Interface CourseEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CourseEntrySearch
extends OsidSearch

The search interface for governing course entry searches.

Method Summary

Modifier and Type	Method	Description
CourseEntrySearchRecord	getCourseEntrySearchRecord(Type courseEntrySearchRecordType)	Gets the course entry search record corresponding to the given course entry search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCourseEntryResults(CourseEntrySearchOrder courseEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongCourseEntries(IdList courseEntryIds)	Execute this search among the given list of course entries.

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

searchAmongCourseEntries

void searchAmongCourseEntries(IdList courseEntryIds)

Execute this search among the given list of course entries.

Parameters:

courseEntryIds - list of course entry Ids

Throws:

NullArgumentException - courseEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderCourseEntryResults

void orderCourseEntryResults(CourseEntrySearchOrder courseEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

courseEntrySearchOrder - course entry search order

Throws:

NullArgumentException - courseEntrySearchOrder is null

UnsupportedException - courseEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseEntrySearchRecord

CourseEntrySearchRecord getCourseEntrySearchRecord(Type courseEntrySearchRecordType)
                                            throws OperationFailedException

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

Parameters:

courseEntrySearchRecordType - a course entry search record type

Returns:

the course entry search record

Throws:

NullArgumentException - courseEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.