| Interface | osid.subscription.rules.SubscriptionEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getSubscriptionEnablers | ||
| Description |
Gets the | ||
| Return | osid.subscription.rules.SubscriptionEnablerList | the subscription enabler list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriptionEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.subscription.rules.SubscriptionEnablerQueryInspector | the subscription enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriptionEnablerSearchResultsRecord | ||
| Description |
Gets the subscription enabler search results record
corresponding to the given subscription enabler search
record | ||
| Parameters | osid.type.Type | subscriptionEnablerSearchRecordType | a subscription enabler search record type |
| Return | osid.subscription.rules.records.SubscriptionEnablerSearchResultsRecord | the subscription enabler search results record | |
| Errors | NULL_ARGUMENT | subscriptionEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(subscriptionEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |