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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

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

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.