org.osid.course.plan

Interface LessonSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface LessonSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
LessonQueryInspector	getLessonQueryInspector() Gets the inspector for the query to examine the terns used in the search.
LessonList	getLessons() Gets the lesson list resulting from a search.
LessonSearchResultsRecord	getLessonSearchResultsRecord(Type lessonSearchRecordType) Gets the lesson search results record corresponding to the given lesson search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getLessons

LessonList getLessons()

Gets the lesson list resulting from a search.

Returns:

the lesson list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getLessonQueryInspector

LessonQueryInspector getLessonQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getLessonSearchResultsRecord

LessonSearchResultsRecord getLessonSearchResultsRecord(Type lessonSearchRecordType)
                                                       throws OperationFailedException

Gets the lesson search results 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 results record

Throws:

NullArgumentException - LessonSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(lessonSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.