Interface | osid.learning.ObjectiveSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getObjectives | ||
Description |
Gets the objective list resulting from the search. | ||
Return | osid.learning.ObjectiveList | the objective list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.learning.ObjectiveQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveSearchResultsRecord | ||
Description |
Gets the objective search results record corresponding
to the given objective search record | ||
Parameters | osid.type.Type | objectiveSearchRecordType | an objective search record type |
Return | osid.learning.records.ObjectiveSearchResultsRecord | the objective search results record | |
Errors | NULL_ARGUMENT | objectiveSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasSearchRecordType(objectiveSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |