Interface | osid.provisioning.rules.BrokerProcessorRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignBrokerProcessors | ||
Description |
Tests if this user can alter broker processor/broker
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 | assignBrokerProcessorToBroker | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | brokerProcessorId | the Id of the BrokerProcessor |
osid.id.Id | brokerId | the Id of the Broker | |
Errors | ALREADY_EXISTS | brokerProcessorId is already applied to brokerId
| |
NOT_FOUND | brokerProcessorId or brokerId not found | ||
NULL_ARGUMENT | brokerProcessorId or brokerId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignBrokerProcessorFromBroker | ||
Description |
Removes a | ||
Parameters | osid.id.Id | brokerProcessorId | the Id of the BrokerProcessor |
osid.id.Id | brokerId | the Id of the Broker | |
Errors | NOT_FOUND | brokerProcessorId or brokerId not found or
brokerProcessorId not applied to brokerId | |
NULL_ARGUMENT | brokerProcessorId or brokerId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceBrokerProcessors | ||
Description |
Tests if this user can order | ||
Return | boolean | false if BrokerProcessor ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveBrokerProcessorAhead | ||
Description |
Reorders broker processors for a broker by moving the specified broker processor in front of a reference broker processor. | ||
Parameters | osid.id.Id | brokerProcessorId | the Id of a BrokerProcessor |
osid.id.Id | brokerId | the Id of a Broker | |
osid.id.Id | referenceId | the reference broker processor Id | |
Errors | NOT_FOUND | brokerProcessorId, brokerId, or referenceId
not found or, brokerProcessorId or referenceId
not related to brokerId | |
NULL_ARGUMENT | brokerProcessorId, brokerId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveBrokerProcessorBehind | ||
Description |
Reorders broker processors for a broker by moving the specified broker processor behind a reference broker processor. | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of a BrokerProcessor |
osid.id.Id | brokerProcessorId | the Id of a Broker | |
osid.id.Id | brokerId | the reference broker processor Id | |
Errors | NOT_FOUND | brokerProcessorId, brokerId, or referenceId
not found or, brokerProcessorId or referenceId
not related to brokerId | |
NULL_ARGUMENT | brokerProcessorId, brokerId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderBrokerProcessors | ||
Description |
Reorders a set of broker processors for a broker. | ||
Parameters | osid.id.Id[] | brokerProcessorIds | the Ids for a set of BrokerProcessors |
osid.id.Id | brokerId | the Id of a Broker | |
Errors | NOT_FOUND | brokerId not found or, a brokerProcessorId
not related to brokerId | |
NULL_ARGUMENT | brokerProcessorIds or brokerId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |