OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
configuration package
Version 3.0.0
Release Candidate Preview
| Interface | osid.configuration.ValueSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing value searches. | ||
| Method | searchAmongValues | ||
| Description |
Executes this search among a given list of values. | ||
| Parameters | osid.id.IdList | valueIds | list of values |
| Errors | NULL_ARGUMENT | valueIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderValueResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.configuration.ValueSearchOrder | valueSearchOrder | value search order |
| Errors | NULL_ARGUMENT | valueSearchOrder is null | |
| UNSUPPORTED | valueSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueSearchRecord | ||
| Description |
Gets the value search record corresponding to the given
value search record | ||
| Parameters | osid.type.Type | valueSearchRecordType | a value search record type |
| Return | osid.configuration.records.ValueSearchRecord | the value search 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. | |