public interface EnrollmentSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
EnrollmentList getEnrollments()
IllegalStateException
- the enrollment list has already
been retrievedmandatory
- This method must be implemented. EnrollmentQueryInspector getEnrollmentQueryInspector()
mandatory
- This method must be implemented. EnrollmentSearchResultsRecord getEnrollmentSearchResultsRecord(Type enrollmentSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.enrollmentSearchRecordType
- an enrollment search record typeNullArgumentException
-
enrollmentSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(enrollmentSearchRecordType)
is
false
mandatory
- This method must be implemented.