org.osid.course

Interface CourseOfferingSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CourseOfferingSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CourseOfferingQueryInspector	getCourseOfferingQueryInspector() Gets the inspector for the query to examine the terms used in the search.
CourseOfferingList	getCourseOfferings() Gets the course offering list resulting from a search.
CourseOfferingSearchResultsRecord	getCourseOfferingSearchResultsRecord(Type courseOfferingSearchRecordType) Gets the course offering search results record corresponding to the given course offering 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

getCourseOfferings

CourseOfferingList getCourseOfferings()

Gets the course offering list resulting from a search.

Returns:

the course offering list

Throws:

IllegalStateException - the course offering list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCourseOfferingQueryInspector

CourseOfferingQueryInspector getCourseOfferingQueryInspector()

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.

getCourseOfferingSearchResultsRecord

CourseOfferingSearchResultsRecord getCourseOfferingSearchResultsRecord(Type courseOfferingSearchRecordType)
                                                                       throws OperationFailedException

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

Parameters:

courseOfferingSearchRecordType - a course offering search record type

Returns:

the course offering search results record

Throws:

NullArgumentException - courseOfferingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseOfferingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.