Interface | osid.subscription.SubscriptionSearchSession | ||
---|---|---|---|
Implements | osid.subscription.SubscriptionQuerySession | ||
Description |
This session provides methods for searching Subscriptions may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getSubscriptionSearch | ||
Description |
Gets a subscription search. | ||
Return | osid.subscription.SubscriptionSearch | the subscription search | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionSearchOrder | ||
Description |
Gets a subscription search order. The | ||
Return | osid.subscription.SubscriptionSearchOrder | the subscription search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsBySearch | ||
Description |
Gets the subscription search results matching the given search. | ||
Parameters | osid.subscription.SubscriptionQuery | subscriptionQuery | the subscription query |
osid.subscription.SubscriptionSearch | subscriptionSearch | the subscription search | |
Return | osid.subscription.SubscriptionSearchResults | the subscription search results | |
Errors | NULL_ARGUMENT | subscriptionQuery or subscriptionSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | subscriptionQuery or subscriptionSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.subscription.SubscriptionQueryInspector | subscriptionQueryInspector | a query inspector |
Return | osid.subscription.SubscriptionQuery | the entry query | |
Errors | NULL_ARGUMENT | subscriptionQueryInspector is null | |
UNSUPPORTED | subscriptionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |