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