org.osid.course.registration

Interface RegistrationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RegistrationSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
RegistrationQueryInspector	getRegistrationQueryInspector() Gets the inspector for the query to examine the terms used in the search.
RegistrationList	getRegistrations() Gets the registration list resulting from a search.
RegistrationSearchResultsRecord	getRegistrationSearchResultsRecord(Type registrationSearchRecordType) Gets the registration search results record corresponding to the given registration 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

getRegistrations

RegistrationList getRegistrations()

Gets the registration list resulting from a search.

Returns:

the registration list

Throws:

IllegalStateException - the registration list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRegistrationQueryInspector

RegistrationQueryInspector getRegistrationQueryInspector()

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.

getRegistrationSearchResultsRecord

RegistrationSearchResultsRecord getRegistrationSearchResultsRecord(Type registrationSearchRecordType)
                                                                   throws OperationFailedException

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

Parameters:

registrationSearchRecordType - a registration search record type

Returns:

the registration search results record

Throws:

NullArgumentException - registrationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.