public interface ObjectiveSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ObjectiveQueryInspector |
getObjectiveQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ObjectiveList |
getObjectives()
Gets the objective list resulting from the search.
|
ObjectiveSearchResultsRecord |
getObjectiveSearchResultsRecord(Type objectiveSearchRecordType)
Gets the objective search results record corresponding to the given
objective search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ObjectiveList getObjectives()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. ObjectiveQueryInspector getObjectiveQueryInspector()
mandatory
- This method must be implemented. ObjectiveSearchResultsRecord getObjectiveSearchResultsRecord(Type objectiveSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.objectiveSearchRecordType
- an objective search record typeNullArgumentException
-
objectiveSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasSearchRecordType(objectiveSearchRecordType)
is
false
mandatory
- This method must be implemented.