Interface | osid.configuration.ConfigurationSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getConfigurations | ||
Description |
Gets the configuration list resulting from a search. | ||
Return | osid.configuration.ConfigurationList | the configuration list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.configuration.ConfigurationQueryInspector | the configuration query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationSearchResultsRecord | ||
Description |
Gets the configuration search results record corresponding to the given configuration search record Type. This method is used to retrieve an object implementing the requested record. | ||
Parameters | osid.type.Type | configurationSearchRecordType | a configuration search record type |
Return | osid.configuration.records.ConfigurationSearchResultsRecord | the configuration search results | |
Errors | NULL_ARGUMENT | configurationSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(configurationSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |