Interface CourseRegistrationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CourseRegistrationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CourseRegistrationQueryInspector	getCourseRegistrationQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CourseRegistrationList	getCourseRegistrations()	Gets the course registration list resulting from a search.
CourseRegistrationSearchResultsRecord	getCourseRegistrationSearchResultsRecord(Type courseRegistrationSearchRecordType)	Gets the course registration search results record corresponding to the given course registration search record Type.

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

getCourseRegistrations

CourseRegistrationList getCourseRegistrations()

Gets the course registration list resulting from a search.

Returns:

the course registration list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCourseRegistrationQueryInspector

CourseRegistrationQueryInspector getCourseRegistrationQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the course registration query inspector

Compliance:

mandatory - This method must be implemented.

getCourseRegistrationSearchResultsRecord

CourseRegistrationSearchResultsRecord getCourseRegistrationSearchResultsRecord(Type courseRegistrationSearchRecordType)
                                                                        throws OperationFailedException

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

Parameters:

courseRegistrationSearchRecordType - a course registration search record type

Returns:

the course registration search results record

Throws:

NullArgumentException - courseRegistrationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseRegistrationSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.