Interface | osid.configuration.ConfigurationSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface to query a configuration. | ||
Method | searchAmongConfigurations | ||
Description |
Execute this search among the given list of configurations. | ||
Parameters | osid.id.IdList | configurationIds | list of configurations |
Errors | NULL_ARGUMENT | configurationIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderConfigurationResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.configuration.ConfigurationSearchOrder | configurationSearchOrder | configuration search order |
Errors | NULL_ARGUMENT | configurationSearchOrder is null | |
UNSUPPORTED | configurationSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationSearchRecord | ||
Description |
Gets the configuration search record corresponding to
the given configuration search record | ||
Parameters | osid.type.Type | configurationSearchRecordType | a configuration search record type |
Return | osid.configuration.records.ConfigurationSearchRecord | the configuration search record | |
Errors | NULL_ARGUMENT | configurationSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(configurationSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |