Interface | osid.provisioning.rules.BrokerProcessorEnablerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignBrokerProcessorEnablers | ||
Description |
Tests if this user can alter broker processor
enabler/broker processor 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 | assignBrokerProcessorEnablerToBrokerProcessor | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of the BrokerProcessorEnabler |
osid.id.Id | brokerProcessorId | the Id of the BrokerProcessor | |
Errors | ALREADY_EXISTS | brokerProcessorEnablerId is already applied to
brokerProcessorId | |
NOT_FOUND | brokerProcessorEnablerId or brokerProcessorId
not found | ||
NULL_ARGUMENT | brokerProcessorEnablerId or brokerProcessorId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignBrokerProcessorEnablerFromBrokerProcessor | ||
Description |
Removes a | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of the BrokerProcessorEnabler |
osid.id.Id | brokerProcessorId | the Id of the BrokerProcessor | |
Errors | NOT_FOUND | brokerProcessorEnablerId or brokerProcessorId
not found or brokerProcessorEnablerId not applied to
brokerProcessorId | |
NULL_ARGUMENT | brokerProcessorEnablerId or brokerProcessorId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceBrokerProcessorEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if BrokerProcessorEnabler ordering is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveBrokerProcessorEnablerAhead | ||
Description |
Reorders broker processor enablers for a broker processor by moving the specified broker processor enabler in front of a reference broker processor enabler. | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of a BrokerProcessorEnabler |
osid.id.Id | brokerProcessorId | the Id of a BrokerProcessor | |
osid.id.Id | referenceId | the reference broker processor enabler Id | |
Errors | NOT_FOUND | brokerProcessorEnablerId, brokerProcessorId, or
referenceId not found or, brokerProcessorEnablerId or
referenceId not related to brokerProcessorId | |
NULL_ARGUMENT | brokerProcessorEnablerId, brokerProcessorId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveBrokerProcessorEnablerBehind | ||
Description |
Reorders broker processor enablers for a broker processor by moving the specified broker processor enabler behind a reference broker processor enabler. | ||
Parameters | osid.id.Id | brokerProcessorEnablerId | the Id of a BrokerProcessorEnabler |
osid.id.Id | brokerProcessorId | the Id of a BrokerProcessor | |
osid.id.Id | referenceId | the reference broker processor enabler Id | |
Errors | NOT_FOUND | brokerProcessorEnablerId, brokerProcessorId, or
referenceId not found or, brokerProcessorEnablerId or
referenceId not related to brokerProcessorId | |
NULL_ARGUMENT | brokerProcessorEnablerId, brokerProcessorId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderBrokerProcessorEnablers | ||
Description |
Reorders a set of broker processor enablers for a broker processor. | ||
Parameters | osid.id.Id[] | brokerProcessorEnablerIds | the Ids for a set of BrokerProcessorEnablers |
osid.id.Id | brokerProcessorId | the Id of a BrokerProcessor | |
Errors | NOT_FOUND | brokerProcessorId not found or, a
brokerProcessorEnablerId not related to brokerProcessorId
| |
NULL_ARGUMENT | brokerProcessorEnablerIds or brokerProcessorId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |