| Interface | osid.subscription.rules.SubscriptionEnablerPublisherAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignSubscriptionEnablers | ||
| Description |
Tests if this user can alter subscription
enabler/publisher 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 | canAssignSubscriptionEnablersToPublisher | ||
| Description |
Tests if this user can alter subscription
enabler/publisher 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 | ||
| Parameters | osid.id.Id | publisherId | the Id of the Publisher |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | publisherId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignablePublisherIds | ||
| Description |
Gets a list of publishers including and under the given publisher node in which any publisher enabler can be assigned. | ||
| Parameters | osid.id.Id | publisherId | the Id of the Publisher |
| Return | osid.id.IdList | list of assignable subscription Ids | |
| Errors | NULL_ARGUMENT | publisherId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignablePublisherIdsForSubscriptionEnabler | ||
| Description |
Gets a list of publishers including and under the given publisher node in which a specific publisher enabler can be assigned. | ||
| Parameters | osid.id.Id | publisherId | the Id of the Publisher |
osid.id.Id | subscriptionEnablerId | the Id of the SubscriptionEnabler | |
| Return | osid.id.IdList | list of assignable publisher Ids | |
| Errors | NULL_ARGUMENT | publisherId or subscriptionEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignSubscriptionEnablerToPublisher | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | subscriptionEnablerId | the Id of the SubscriptionEnabler |
osid.id.Id | publisherId | the Id of the Publisher | |
| Errors | ALREADY_EXISTS | subscriptionEnablerId is already assigned to
publisherId | |
| NOT_FOUND | subscriptionEnablerId or publisherId not
found | ||
| NULL_ARGUMENT | subscriptionEnablerId or publisherId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignSubscriptionEnablerFromPublisher | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | subscriptionEnablerId | the Id of the SubscriptionEnabler |
osid.id.Id | publisherId | the Id of the Publisher | |
| Errors | NOT_FOUND | subscriptionEnablerId or publisherId not
found or subscriptionEnablerId not assigned to
publisherId | |
| NULL_ARGUMENT | subscriptionEnablerId or publisherId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignSubscriptionEnablerToPublisher | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | subscriptionEnablerId | the Id of the SubscriptionEnabler |
osid.id.Id | fromPublisherId | the Id of the current Publisher | |
osid.id.Id | toPublisherId | the Id of the destination Publisher | |
| Errors | NOT_FOUND | subscriptionEnablerId, fromPublisherId, or
toPublisherId not found or subscriptionEnablerId not
mapped to fromPublisherId | |
| NULL_ARGUMENT | subscriptionEnablerId, fromPublisherId, or
toPublisherId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |