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