OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
configuration package
Version 3.0.0
Release Candidate Preview
| Interface | osid.configuration.ParameterSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getParameters | ||
| Description |
Gets the parameter list resulting from a search. | ||
| Return | osid.configuration.ParameterList | the parameter list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.configuration.ParameterQueryInspector | the parameter query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterSearchResultsRecord | ||
| Description |
Gets the parameter search results record corresponding
to the given parameter search record | ||
| Parameters | osid.type.Type | parameterSearchRecordType | a parameter search record type |
| Return | osid.configuration.records.ParameterSearchResultsRecord | the parameter search results record | |
| Errors | NULL_ARGUMENT | parameterSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(parameterSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |