| Interface | osid.provisioning.rules.ProvisionableEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.provisioning.rules.ProvisionableEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProvisionableEnablers | ||
| Description |
Gets the provisionable enabler list resulting from a search. | ||
| Return | osid.provisioning.rules.ProvisionableEnablerList | the provisionable enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionableEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.rules.ProvisionableEnablerQueryInspector | the provisionable enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProvisionableEnablerSearchResultsRecord | ||
| Description |
Gets the provisionable enabler search results record
corresponding to the given provisionable enabler search
record | ||
| Parameters | osid.type.Type | provisionableEnablerSearchRecordType | a provisionable enabler search record type |
| Return | osid.provisioning.rules.records.ProvisionableEnablerSearchResultsRecord | the provisionable enabler search results record | |
| Errors | NULL_ARGUMENT | provisionableEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(provisionableEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |