Interface EnrollmentSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EnrollmentSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
EnrollmentQueryInspector	getEnrollmentQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
EnrollmentList	getEnrollments()	Gets the enrollment list resulting from a search.
EnrollmentSearchResultsRecord	getEnrollmentSearchResultsRecord(Type enrollmentSearchRecordType)	Gets the enrollment search results record corresponding to the given enrollment 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

getEnrollments

EnrollmentList getEnrollments()

Gets the enrollment list resulting from a search.

Returns:

the enrollment list

Throws:

IllegalStateException - the enrollment list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getEnrollmentQueryInspector

EnrollmentQueryInspector getEnrollmentQueryInspector()

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.

getEnrollmentSearchResultsRecord

EnrollmentSearchResultsRecord getEnrollmentSearchResultsRecord(Type enrollmentSearchRecordType)
                                                        throws OperationFailedException

Gets the enrollment search results 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 interface

Throws:

NullArgumentException - enrollmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(enrollmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.