Interface | osid.subscription.rules.SubscriptionEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
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 | canAssignSubscriptionEnablers | ||
Description |
Tests if this user can alter subscription
enabler/subscription mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known mapping methods in this session
will result in a | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignSubscriptionEnablerToSubscription | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | subscriptionEnablerId | the Id of the SubscriptionEnabler |
osid.id.Id | subscriptionId | the Id of the Subscription | |
Errors | ALREADY_EXISTS | subscriptionEnablerId is already applied to
subscriptionId | |
NOT_FOUND | subscriptionEnablerId or subscriptionId not
found | ||
NULL_ARGUMENT | subscriptionEnablerId or subscriptionId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignSubscriptionEnablerFromSubscription | ||
Description |
Removes a | ||
Parameters | osid.id.Id | subscriptionEnablerId | the Id of the SubscriptionEnabler |
osid.id.Id | subscriptionId | the Id of the Subscription | |
Errors | NOT_FOUND | subscriptionEnablerId or subscriptionId not
found or subscriptionEnablerId not applied to
subscriptionId | |
NULL_ARGUMENT | subscriptionEnablerId or subscriptionId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceSubscriptionEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if SubscriptionEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveSubscriptionEnablerAhead | ||
Description |
Reorders subscription enablers for a subscription by moving the specified subscription enabler in front of a reference subscription enabler. | ||
Parameters | osid.id.Id | subscriptionEnablerId | the Id of a SubscriptionEnabler |
osid.id.Id | subscriptionId | the Id of a Subscription | |
osid.id.Id | referenceId | the reference subscription enabler Id | |
Errors | NOT_FOUND | subscriptionEnablerId, subscriptionId, or referenceId
not found or, subscriptionEnabelrId or
referenceId not related to subscriptionId | |
NULL_ARGUMENT | subscriptionEnablerId, subscriptionId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveSubscriptionEnablerBehind | ||
Description |
Reorders subscription enablers for a subscription by moving the specified subscription enabler behind a reference subscription enabler. | ||
Parameters | osid.id.Id | subscriptionEnablerId | the Id of a SubscriptionEnabler |
osid.id.Id | subscriptionId | the Id of a Subscription | |
osid.id.Id | referenceId | the reference subscription enabler Id | |
Errors | NOT_FOUND | subscriptionEnablerId, subscriptionId, or referenceId
not found or, subscriptionEnabelrId or
referenceId not related to subscriptionId | |
NULL_ARGUMENT | subscriptionEnablerId, subscriptionId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderSubscriptionEnablers | ||
Description |
Reorders a set of subscription enablers for a subscription. | ||
Parameters | osid.id.Id[] | subscriptionEnablerIds | the Ids for a set of SubscriptionEnablers |
osid.id.Id | subscriptionId | the Id of a Subscription | |
Errors | NOT_FOUND | subscriptionId not found or, an subscriptionEnabelrId
not related to subscriptionId | |
NULL_ARGUMENT | subscriptionEnablerIds or subscriptionId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |