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

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

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.