| Interface | osid.provisioning.rules.ProvisionEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.provisioning.rules.ProvisionEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProvisionEnablers | ||
| Description |
Gets the provision enabler list resulting from a search. | ||
| Return | osid.provisioning.rules.ProvisionEnablerList | the provision enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.rules.ProvisionEnablerQueryInspector | the provision enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionEnablerSearchResultsRecord | ||
| Description |
Gets the provision enabler search results record
corresponding to the given provision enabler search record
| ||
| Parameters | osid.type.Type | provisionEnablerSearchRecordType | a provision enabler search record type |
| Return | osid.provisioning.rules.records.ProvisionEnablerSearchResultsRecord | the provision enabler search results record | |
| Errors | NULL_ARGUMENT | provisionEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(provisionEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |