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

Modifier and Type	Method	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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.