Interface | osid.provisioning.rules.BrokerConstrainerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignBrokerConstrainers | ||
Description |
Tests if this user can alter broker constrainer/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 | assignBrokerConstrainerToBroker | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | brokerConstrainerId | the Id of the BrokerConstrainer |
osid.id.Id | brokerId | the Id of the Broker | |
Errors | ALREADY_EXISTS | brokerConstrainerId is already applied to brokerId
| |
NOT_FOUND | brokerConstrainerId or brokerId not found | ||
NULL_ARGUMENT | brokerConstrainerId or brokerId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignBrokerConstrainerFromBroker | ||
Description |
Removes a | ||
Parameters | osid.id.Id | brokerConstrainerId | the Id of the BrokerConstrainer |
osid.id.Id | brokerId | the Id of the Broker | |
Errors | NOT_FOUND | brokerConstrainerId or brokerId not found or
brokerConstrainerId not applied to brokerId | |
NULL_ARGUMENT | brokerConstrainerId or brokerId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceBrokerConstrainers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if BrokerConstrainer ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveBrokerConstrainerAhead | ||
Description |
Reorders broker constrainers for a broker by moving the specified broker constrainer in front of a reference broker. | ||
Parameters | osid.id.Id | brokerConstrainerId | the Id of a BrokerConstrainer |
osid.id.Id | brokerId | the Id of a Broker | |
osid.id.Id | referenceId | the reference broker constrainer Id | |
Errors | NOT_FOUND | brokerConstrainerId, brokerId, or referenceId
not found or, brokerConstrainerId or referenceId
not related to brokerId | |
NULL_ARGUMENT | brokerConstrainerId, brokerId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveBrokerConstrainerBehind | ||
Description |
Reorders broker constrainers for a broker by moving the specified broker constrainer behind a reference broker. | ||
Parameters | osid.id.Id | brokerConstrainerId | the Id of a BrokerConstrainer |
osid.id.Id | brokerId | the Id of a Broker | |
osid.id.Id | referenceId | the reference broker constrainer Id | |
Errors | NOT_FOUND | brokerConstrainerId, brokerId, or referenceId
not found or, brokerConstrainerId or referenceId
not related to brokerId | |
NULL_ARGUMENT | brokerConstrainerId, brokerId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderBrokerConstrainers | ||
Description |
Reorders a set of broker constrainers for a broker. | ||
Parameters | osid.id.Id[] | brokerConstrainerIds | the Ids for a set of BrokerConstrainers |
osid.id.Id | brokerId | the Id of a Broker | |
Errors | NOT_FOUND | brokerId not found or, a brokerConstrainerId
not related to brokerId | |
NULL_ARGUMENT | brokerConstrainerIds or brokerId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |