Interface | osid.subscription.rules.SubscriptionEnablerLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | canLookupSubscriptionEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSubscriptionEnablerView | ||
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 | usePlenarySubscriptionEnablerView | ||
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 subscription enablers 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 lookups to this publisher only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveSubscriptionEnablerView | ||
Description |
Only active subscription enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusSubscriptionEnablerView | ||
Description |
All active and inactive subscription enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSubscriptionEnabler | ||
Description |
Gets the In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Parameters | osid.id.Id | subscriptionEnablerId | Id of the SubscriptionEnabler |
Return | osid.subscription.rules.SubscriptionEnabler | the subscription enabler | |
Errors | NOT_FOUND | subscriptionEnablerId not found | |
NULL_ARGUMENT | subscriptionEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSubscriptionEnablersByIds | ||
Description |
Gets a In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Parameters | osid.id.IdList | subscriptionEnablerIds | the list of Ids to retrieve |
Return | osid.subscription.rules.SubscriptionEnablerList | the returned SubscriptionEnabler list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | subscriptionEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablersByGenusType | ||
Description |
Gets a In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Parameters | osid.type.Type | subscriptionEnablerGenusType | a subscription enabler genus type |
Return | osid.subscription.rules.SubscriptionEnablerList | the returned SubscriptionEnabler list | |
Errors | NULL_ARGUMENT | subscriptionEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablersByParentGenusType | ||
Description |
Gets a In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Parameters | osid.type.Type | subscriptionEnablerGenusType | a subscription enabler genus type |
Return | osid.subscription.rules.SubscriptionEnablerList | the returned SubscriptionEnabler list | |
Errors | NULL_ARGUMENT | subscriptionEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablersByRecordType | ||
Description |
Gets a In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Parameters | osid.type.Type | subscriptionEnablerRecordType | a subscription enabler record type |
Return | osid.subscription.rules.SubscriptionEnablerList | the returned SubscriptionEnabler list | |
Errors | NULL_ARGUMENT | subscriptionEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablersOnDate | ||
Description |
Gets a In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.subscription.rules.SubscriptionEnablerList | the returned SubscriptionEnabler 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 | getSubscriptionEnablersOnDateWithAgent | ||
Description |
Gets a In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Parameters | osid.id.Id | agentId | an agent Id |
osid.calendaring.DateTime | from | a start date | |
osid.calendaring.DateTime | to | an end date | |
Return | osid.subscription.rules.SubscriptionEnablerList | the returned SubscriptionEnabler list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | agentId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned. | ||
Return | osid.subscription.rules.SubscriptionEnablerList | the returned SubscriptionEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |