Interface RegistrationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RegistrationSearch
extends OsidSearch

The search interface for governing registration searches.

Method Summary

Modifier and Type	Method	Description
RegistrationSearchRecord	getRegistrationSearchRecord(Type registrationSearchRecordType)	Gets the registration search record corresponding to the given registration search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRegistrationResults(RegistrationSearchOrder registrationSearchOrder)	Specify an ordering to the search results.
void	searchAmongRegistrations(IdList registrationIds)	Execute this search among the given list of registrations.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongRegistrations

void searchAmongRegistrations(IdList registrationIds)

Execute this search among the given list of registrations.

Parameters:

registrationIds - list of courses

Throws:

NullArgumentException - registrationIds is null

Compliance:

mandatory - This method must be implemented.

orderRegistrationResults

void orderRegistrationResults(RegistrationSearchOrder registrationSearchOrder)

Specify an ordering to the search results.

Parameters:

registrationSearchOrder - course search order

Throws:

NullArgumentException - registrationSearchOrder is null

UnsupportedException - registrationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRegistrationSearchRecord

RegistrationSearchRecord getRegistrationSearchRecord(Type registrationSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

registrationSearchRecordType - a course search record type

Returns:

the registration search record

Throws:

NullArgumentException - registrationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.