org.osid.course.chronicle

Interface CourseEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CourseEntrySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CourseEntryList	getCourseEntries() Gets the course list resulting from a search.
CourseEntryQueryInspector	getCourseEntryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
CourseEntrySearchResultsRecord	getCourseEntrySearchResultsRecord(Type courseEntrySearchRecordType) Gets the course entry search results record corresponding to the given course entry 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

getCourseEntries

CourseEntryList getCourseEntries()

Gets the course list resulting from a search.

Returns:

the course entry list

Throws:

IllegalStateException - the course entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCourseEntryQueryInspector

CourseEntryQueryInspector getCourseEntryQueryInspector()

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.

getCourseEntrySearchResultsRecord

CourseEntrySearchResultsRecord getCourseEntrySearchResultsRecord(Type courseEntrySearchRecordType)
                                                                 throws OperationFailedException

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

Parameters:

courseEntrySearchRecordType - a course entry search record type

Returns:

the course entry search results record

Throws:

NullArgumentException - courseEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.