Interface | osid.inventory.ModelSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getModels | ||
Description |
Gets the model list resulting from a search. | ||
Return | osid.inventory.ModelList | the model list | |
Errors | ILLEGAL_STATE | the model list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getModelQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.inventory.ModelQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getModelSearchResultsRecord | ||
Description |
Gets the model search results record corresponding to
the given model search record | ||
Parameters | osid.type.Type | modelSearchRecordType | a model search record type |
Return | osid.inventory.records.ModelSearchResultsRecord | the model search results record | |
Errors | NULL_ARGUMENT | modelSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(modelSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |