Interface | osid.subscription.SubscriptionQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | getPublisherId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Publisher Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublisher | ||
Description |
Gets the | ||
Return | osid.subscription.Publisher | the publisher | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchSubscriptions | ||
Description |
Tests if this user can perform susbcription searches. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedPublisherView | ||
Description |
Federates the view for methods in this session. A federated view will include entries in publishers which are children of this publisher in the publisher hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedPublisherView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this publisher only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSubscriptionQuery | ||
Description |
Gets a subscription query. | ||
Return | osid.subscription.SubscriptionQuery | the subscription query | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByQuery | ||
Description |
Gets a list of subscriptions matching the given subscription query. | ||
Parameters | osid.subscription.SubscriptionQuery | subscriptionQuery | the subscription query |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | NULL_ARGUMENT | subscriptionQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | subscriptionQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |