OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
configuration package
Version 3.0.0
Release Candidate Preview
| Interface | osid.configuration.ValueSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getValues | ||
| Description |
Gets the vakue list resulting from a search. | ||
| Return | osid.configuration.ValueList | the value list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.configuration.ValueQueryInspector | the value query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueSearchResultsRecord | ||
| Description |
Gets the value search results record corresponding to the given value search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | valueSearchRecordType | a value search record type |
| Return | osid.configuration.records.ValueSearchResultsRecord | the value search results record | |
| Errors | NULL_ARGUMENT | valueSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(valueSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |