Interface | osid.configuration.ParameterSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
| ||
Method | searchAmongParameters | ||
Description |
Executes this search among a given list of parameters. | ||
Parameters | osid.id.IdList | parameterIds | list of parameters |
Errors | NULL_ARGUMENT | parameterIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderParameterResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.configuration.ParameterSearchOrder | parameterSearchOrder | parameter search order |
Errors | NULL_ARGUMENT | parameterSearchOrder is null | |
UNSUPPORTED | parameterSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterSearchRecord | ||
Description |
Gets the parameter search record corresponding to the
given parameter search record | ||
Parameters | osid.type.Type | parameterSearchRecordType | a parameter search record type |
Return | osid.configuration.records.ParameterSearchRecord | the parameter search record | |
Errors | NULL_ARGUMENT | parameterRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(parameterSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |