Interface | osid.subscription.SubscriptionLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving subscriptions. This lookup session defines several views:
The methods | ||
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 | canLookupSubscriptions | ||
Description |
Tests if this user can lookup subscriptions. 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 subscription lookup methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSubscriptionView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenarySubscriptionView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 | useEffectiveSubscriptionView | ||
Description |
Only subscriptions whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveSubscriptionView | ||
Description |
All subscriptions of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSubscription | ||
Description |
Gets the In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | subscriptionId | the Id of the Subscription to retrieve |
Return | osid.subscription.Subscription | the returned Subscription | |
Errors | NOT_FOUND | no Subscription found with the given Id | |
NULL_ARGUMENT | subscriptionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByIds | ||
Description |
Gets a In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.IdList | subscriptionIds | the list of Ids to retrieve |
Return | osid.subscription.SubscriptionList | the returned Subscription list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | subscriptionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusType | ||
Description |
Gets a In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.type.Type | subscriptionGenusType | a subscription genus type |
Return | osid.subscription.SubscriptionList | the returned Subscription list | |
Errors | NULL_ARGUMENT | subscriptionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByParentGenusType | ||
Description |
Gets a In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.type.Type | subscriptionGenusType | a subscription genus type |
Return | osid.subscription.SubscriptionList | the returned Subscriptions list | |
Errors | NULL_ARGUMENT | subscriptionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByRecordType | ||
Description |
Gets a In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.type.Type | subscriptionRecordType | a subscription record type |
Return | osid.subscription.SubscriptionList | the returned Subscriptions list | |
Errors | NULL_ARGUMENT | subscriptionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsOnDate | ||
Description |
Gets a In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.subscription.SubscriptionList | the returned Subscriptions list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusTypeOnDate | ||
Description |
Gets a In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.type.Type | subscriptionGenusType | a subscription genus type |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.subscription.SubscriptionList | the returned Subscriptions list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | subscriptionGenusType, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsForSubscriber | ||
Description |
Gets a list of subscriptions corresponding to a
subscriber In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsForSubscriberOnDate | ||
Description |
Gets a list of all subscriptions corresponding to a
subscriber In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusTypeForSubscriber | ||
Description |
Gets a list of subscriptions of the given genus type
corresponding to a subscriber In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.type.Type | subscriptionGenusType | a subscription genus type | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | NULL_ARGUMENT | resourceId or subscriptionGenusType is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusTypeForSubscriberOnDate | ||
Description |
Gets a list of all subscriptions of the given genus
type corresponding to a subscriber In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.type.Type | subscriptionGenusType | a subscription genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, subscriptionGenusType, from or to
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsForDispatch | ||
Description |
Gets a list of all subscriptions corresponding to a
dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | dispatchId | the Id of the dispatch |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | NULL_ARGUMENT | dispatchId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsForDispatchOnDate | ||
Description |
Gets a list of all subscriptions corresponding to a
dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | dispatchId | a dispatch Id |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | dispatchId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusTypeForDispatch | ||
Description |
Gets a list of all subscriptions of the given genus
type corresponding to a dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | dispatchId | the Id of the dispatch |
osid.type.Type | subscriptionGenusType | a subscription genus type | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | NULL_ARGUMENT | dispatchId or subscriptionGenusType is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusTypeForDispatchOnDate | ||
Description |
Gets a list of all subscriptions of the given genus
type corresponding to a dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | dispatchId | a dispatch Id |
osid.type.Type | subscriptionGenusType | a subscription genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | dispatchId, subscriptionGenusType, from or to
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsForSubscriberAndDispatch | ||
Description |
Gets a list of all subscriptions corresponding to a
susbcriber and dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | dispatchId | the Id of the dispatch | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | NULL_ARGUMENT | resourceId or dispatchId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsForSubscriberAndDispatchOnDate | ||
Description |
Gets a list of all subscriptions corresponding to a
subscriber and dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | dispatchId | a dispatch Id | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, dispatchI, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusTypeForSubscriberAndDispatch | ||
Description |
Gets a list of all subscriptions of the given genus
type corresponding to a susbcriber and dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | dispatchId | the Id of the dispatch | |
osid.type.Type | subscriptionGenusType | a subscription genus type | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | NULL_ARGUMENT | resourceId, dispatchId or subscriptionGenusType
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionsByGenusTypeForSubscriberAndDispatchOnDate | ||
Description |
Gets a list of all subscriptions of the given genus
type corresponding to a subscriber and dispatch In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | the Id of the resource |
osid.id.Id | dispatchId | a dispatch Id | |
osid.type.Type | subscriptionGenusType | a subscription genus type | |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.subscription.SubscriptionList | the returned SubscriptionList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, dispatch, subscriptionGenusType, from or
to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptions | ||
Description |
Gets all subscriptions. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned. | ||
Return | osid.subscription.SubscriptionList | a list of subscriptions | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |