| Interface | osid.provisioning.rules.QueueProcessorEnablerDistributorAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignQueueProcessorEnablers | ||
| Description |
Tests if this user can alter queue processor
enabler/distributor 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 | canAssignQueueProcessorEnablersToDistributor | ||
| Description |
Tests if this user can alter queue processor
enabler/distributor 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 | distributorId | the Id of the Distributor |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | distributorId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableDistributorIds | ||
| Description |
Gets a list of distributors including and under the given distributor node in which any queue processor enabler can be assigned. | ||
| Parameters | osid.id.Id | distributorId | the Id of the Distributor |
| Return | osid.id.IdList | list of assignable distributor Ids | |
| Errors | NULL_ARGUMENT | distributorId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableDistributorIdsForQueueProcessorEnabler | ||
| Description |
Gets a list of distributors including and under the given distributor node in which a specific queue processor enabler can be assigned. | ||
| Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.id.Id | queueProcessorEnablerId | the Id of the QueueProcessorEnabler | |
| Return | osid.id.IdList | list of assignable distributor Ids | |
| Errors | NULL_ARGUMENT | distributorId or queueProcessorEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignQueueProcessorEnablerToDistributor | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | queueProcessorEnablerId | the Id of the QueueProcessorEnabler |
osid.id.Id | distributorId | the Id of the Distributor | |
| Errors | ALREADY_EXISTS | queueProcessorEnablerId is already assigned to
distributorId | |
| NOT_FOUND | queueProcessorEnablerId or distributorId not
found | ||
| NULL_ARGUMENT | queueProcessorEnablerId or distributorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignQueueProcessorEnablerFromDistributor | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | queueProcessorEnablerId | the Id of the QueueProcessorEnabler |
osid.id.Id | distributorId | the Id of the Distributor | |
| Errors | NOT_FOUND | queueProcessorEnablerId or distributorId not
found or queueProcessorEnablerId not assigned to
distributorId | |
| NULL_ARGUMENT | queueProcessorEnablerId or distributorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |