org.osid.course

Interface CourseCatalogSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CourseCatalogSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CourseCatalogQueryInspector	getCourseCatalogQueryInspector() Gets the inspector for the query to examine the terms used in the search.
CourseCatalogList	getCourseCatalogs() Gets the course catalog list resulting from a search.
CourseCatalogSearchResultsRecord	getCourseCatalogSearchResultsRecord(Type courseCatalogSearchRecordType) Gets the course catalog search results record corresponding to the given course catalog 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

getCourseCatalogs

CourseCatalogList getCourseCatalogs()

Gets the course catalog list resulting from a search.

Returns:

the course catalog list

Throws:

IllegalStateException - the course catalog list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQueryInspector

CourseCatalogQueryInspector getCourseCatalogQueryInspector()

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.

getCourseCatalogSearchResultsRecord

CourseCatalogSearchResultsRecord getCourseCatalogSearchResultsRecord(Type courseCatalogSearchRecordType)
                                                                     throws OperationFailedException

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

Parameters:

courseCatalogSearchRecordType - a course catalog search record type

Returns:

the course catalog search results record

Throws:

NullArgumentException - courseCatalogSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseCatalogSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.