OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
configuration rules package
Version 3.0.0
Release Candidate Preview
| Interface | osid.configuration.rules.ParameterProcessorEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search for governing parameter processor enabler searches. | ||
| Method | searchAmongParameterProcessorEnablers | ||
| Description |
Execute this search among the given list of parameter processor enablers. | ||
| Parameters | osid.id.IdList | parameterProcessorEnablerIds | list of parameter processor enablers |
| Errors | NULL_ARGUMENT | parameterProcessorEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderParameterProcessorEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.configuration.rules.ParameterProcessorEnablerSearchOrder | parameterProcessorEnablerSearchOrder | parameter processor enabler search order |
| Errors | NULL_ARGUMENT | parameterProcessorEnablerSearchOrder is null | |
| UNSUPPORTED | parameterProcessorEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterProcessorEnablerSearchRecord | ||
| Description |
Gets the parameter processor enabler search record
corresponding to the given parameter processor enabler
search record | ||
| Parameters | osid.type.Type | parameterProcessorEnablerSearchRecordType | a parameter processor enabler search record type |
| Return | osid.configuration.rules.records.ParameterProcessorEnablerSearchRecord | the parameter processor enabler search record | |
| Errors | NULL_ARGUMENT | parameterProcessorEnablerSearchRecordType is null
| |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(parameterProcessorEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |