Interface | osid.provisioning.rules.BrokerProcessorEnablerDistributorAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignBrokerProcessorEnablers | ||
Description |
Tests if this user can alter broker 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 | canAssignBrokerProcessorEnablersToDistributor | ||
Description |
Tests if this user can alter broker 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 broker 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 | getAssignableDistributorIdsForBrokerProcessorEnabler | ||
Description |
Gets a list of distributors including and under the given distributor node in which a specific broker processor enabler can be assigned. | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.id.Id | brokerProcessorEnablerId | the Id of the BrokerProcessorEnabler | |
Return | osid.id.IdList | list of assignable distributor Ids | |
Errors | NULL_ARGUMENT | distributorId or brokerProcessorEnablerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignBrokerProcessorEnablerToDistributor | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of the BrokerProcessorEnabler |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | ALREADY_EXISTS | brokerProcessorEnablerId is already assigned to
distributorId | |
NOT_FOUND | brokerProcessorEnablerId or distributorId not
found | ||
NULL_ARGUMENT | brokerProcessorEnablerId or distributorId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignBrokerProcessorEnablerFromDistributor | ||
Description |
Removes a | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of the BrokerProcessorEnabler |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | NOT_FOUND | brokerProcessorEnablerId or distributorId not
found or brokerProcessorEnablerId not assigned to
distributorId | |
NULL_ARGUMENT | brokerProcessorEnablerId or distributorId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |