Interface EnrollmentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EnrollmentSearch
extends OsidSearch

The search interface for governing enrollment searches.

Method Summary

Modifier and Type	Method	Description
EnrollmentSearchRecord	getEnrollmentSearchRecord(Type enrollmentSearchRecordType)	Gets the enrollment search record corresponding to the given enrollment search record Type .This method is used to retrieve an object implementing the requested record.
void	orderEnrollmentResults(EnrollmentSearchOrder enrollmentSearchOrder)	Specify an ordering to the search results.
void	searchAmongEnrollments(IdList enrollmentIds)	Execute this search among the given list of enrollments.

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

searchAmongEnrollments

void searchAmongEnrollments(IdList enrollmentIds)

Execute this search among the given list of enrollments.

Parameters:

enrollmentIds - list of enrollments

Throws:

NullArgumentException - enrollmentIds is null

Compliance:

mandatory - This method must be implemented.

orderEnrollmentResults

void orderEnrollmentResults(EnrollmentSearchOrder enrollmentSearchOrder)

Specify an ordering to the search results.

Parameters:

enrollmentSearchOrder - enrollment search order

Throws:

NullArgumentException - enrollmentSearchOrder is null

UnsupportedException - enrollmentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEnrollmentSearchRecord

EnrollmentSearchRecord getEnrollmentSearchRecord(Type enrollmentSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

enrollmentSearchRecordType - an enrollment search record type

Returns:

the enrollment search record

Throws:

NullArgumentException - enrollmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(enrollmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.