Interface | osid.subscription.rules.SubscriptionEnablerSearchSession | ||
---|---|---|---|
Implements | osid.subscription.rules.SubscriptionEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getSubscriptionEnablerSearch | ||
Description |
Gets a subscription enabler search. | ||
Return | osid.subscription.rules.SubscriptionEnablerSearch | the subscription enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablerSearchOrder | ||
Description |
Gets a subscription enabler search order. The | ||
Return | osid.subscription.rules.SubscriptionEnablerSearchOrder | the subscription enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.subscription.rules.SubscriptionEnablerQuery | subscriptionEnablerQuery | the subscription enabler query |
osid.subscription.rules.SubscriptionEnablerSearch | subscriptionEnablerSearch | the subscription enabler search | |
Return | osid.subscription.rules.SubscriptionEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | subscriptionEnablerQuery or subscriptionEnablerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | subscriptionEnablerQuery or subscriptionEnablerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablerQueryFromInspector | ||
Description |
Gets a subscription enabler query from an inspector.
The inspector is available from a | ||
Parameters | osid.subscription.rules.SubscriptionEnablerQueryInspector | subscriptionEnablerQueryInspector | a subscription enabler query inspector |
Return | osid.subscription.rules.SubscriptionEnablerQuery | the subscription enabler query | |
Errors | NULL_ARGUMENT | subscriptionEnablerQueryInspector is null | |
UNSUPPORTED | subscriptionEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |