Interface | osid.provisioning.rules.PoolProcessorEnablerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignPoolProcessorEnablers | ||
Description |
Tests if this user can alter pool processor
enabler/pool 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 | assignPoolProcessorEnablerToPoolProcessor | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | poolProcessorEnablerId | the Id of the PoolProcessorEnabler |
osid.id.Id | poolProcessorId | the Id of the PoolProcessor | |
Errors | ALREADY_EXISTS | poolProcessorEnablerId is already applied to
poolProcessorId | |
NOT_FOUND | poolProcessorEnablerId or poolProcessorId not
found | ||
NULL_ARGUMENT | poolProcessorEnablerId or poolProcessorId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPoolProcessorEnablerFromPoolProcessor | ||
Description |
Removes a | ||
Parameters | osid.id.Id | poolProcessorEnablerId | the Id of the PoolProcessorEnabler |
osid.id.Id | poolProcessorId | the Id of the PoolProcessor | |
Errors | NOT_FOUND | poolProcessorEnablerId or poolProcessorId not
found or poolProcessorEnablerId not applied to
poolProcessorId | |
NULL_ARGUMENT | poolProcessorEnablerId or poolProcessorId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequencePoolProcessorEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if PoolProcessorEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | movePoolProcessorEnablerAhead | ||
Description |
Reorders pool processor enablers for a pool processor by moving the specified pool processor enabler in front of a reference pool processor enabler. | ||
Parameters | osid.id.Id | poolProcessorEnablerId | the Id of a PoolProcessorEnabler |
osid.id.Id | poolProcessorId | the Id of a PoolProcessor | |
osid.id.Id | referenceId | the reference pool processor enabler Id | |
Errors | NOT_FOUND | poolProcessorEnablerId, poolProcessorId, or
referenceId not found or, poolProcessorEnablerId or
referenceId not related to poolProcessorId | |
NULL_ARGUMENT | poolProcessorEnablerId, poolProcessorId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | movePoolProcessorEnablerBehind | ||
Description |
Reorders pool processor enablers for a pool processor by moving the specified pool processor enabler behind a reference pool processor enabler. | ||
Parameters | osid.id.Id | poolProcessorEnablerId | the Id of a PoolProcessorEnabler |
osid.id.Id | poolProcessorId | the Id of a PoolProcessor | |
osid.id.Id | referenceId | the reference pool processor enabler Id | |
Errors | NOT_FOUND | poolProcessorEnablerId, poolProcessorId, or
referenceId not found or, poolProcessorEnablerId or
referenceId not related to poolProcessorId | |
NULL_ARGUMENT | poolProcessorEnablerId, poolProcessorId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderPoolProcessorEnablers | ||
Description |
Reorders a set of pool processor enablers for a pool processor. | ||
Parameters | osid.id.Id[] | poolProcessorEnablerIds | the Ids for a set of PoolProcessorEnablers |
osid.id.Id | poolProcessorId | the Id of a PoolProcessor | |
Errors | NOT_FOUND | poolProcessorId not found or, a
poolProcessorEnablerId not related to poolProcessorId | |
NULL_ARGUMENT | poolProcessorEnablerIds or poolProcessorId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |