public interface CourseEntrySearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CourseEntryList |
getCourseEntries()
Gets the course list resulting from a search.
|
CourseEntryQueryInspector |
getCourseEntryQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
CourseEntrySearchResultsRecord |
getCourseEntrySearchResultsRecord(Type courseEntrySearchRecordType)
Gets the course entry search results record corresponding to the given
course entry search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CourseEntryList getCourseEntries()
IllegalStateException
- the course entry list has
already been retrievedmandatory
- This method must be implemented. CourseEntryQueryInspector getCourseEntryQueryInspector()
mandatory
- This method must be implemented. CourseEntrySearchResultsRecord getCourseEntrySearchResultsRecord(Type courseEntrySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.courseEntrySearchRecordType
- a course entry search record typeNullArgumentException
-
courseEntrySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseEntrySearchRecordType)
is
false
mandatory
- This method must be implemented.