Interface LessonSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface LessonSearch
extends OsidSearch

The search interface for governing lesson searches.

Method Summary

Modifier and Type	Method	Description
LessonSearchRecord	getLessonSearchRecord(Type lessonSearchRecordType)	Gets the lesson search record corresponding to the given lesson search record Type.
void	orderLessonResults(LessonSearchOrder lessonSearchOrder)	Specify an ordering to the search results.
void	searchAmongLessons(IdList lessonIds)	Execute this search among the given list of lessons.

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

searchAmongLessons

void searchAmongLessons(IdList lessonIds)

Execute this search among the given list of lessons.

Parameters:

lessonIds - list of lessons

Throws:

NullArgumentException - lessonIds is null

Compliance:

mandatory - This method must be implemented.

orderLessonResults

void orderLessonResults(LessonSearchOrder lessonSearchOrder)

Specify an ordering to the search results.

Parameters:

lessonSearchOrder - lesson search order

Throws:

NullArgumentException - lessonSearchOrder is null

UnsupportedException - lessonSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getLessonSearchRecord

LessonSearchRecord getLessonSearchRecord(Type lessonSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

lessonSearchRecordType - a lesson search record type

Returns:

the lesson search record

Throws:

NullArgumentException - lessonSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(lessonSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.