org.osid.course

Interface CourseSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CourseSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CourseQueryInspector	getCourseQueryInspector() Gets the inspector for the query to examine the terms used in the search.
CourseList	getCourses() Gets the course list resulting from a search.
CourseSearchResultsRecord	getCourseSearchResultsRecord(Type courseSearchRecordType) Gets the course search results record corresponding to the given course 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

getCourses

CourseList getCourses()

Gets the course list resulting from a search.

Returns:

the course list

Throws:

IllegalStateException - the course list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCourseQueryInspector

CourseQueryInspector getCourseQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCourseSearchResultsRecord

CourseSearchResultsRecord getCourseSearchResultsRecord(Type courseSearchRecordType)
                                                       throws OperationFailedException

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

Parameters:

courseSearchRecordType - a course search record type

Returns:

the course search results record

Throws:

NullArgumentException - courseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.