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

Modifier and Type	Method	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 .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

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.