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