Interface | osid.provisioning.rules.PoolConstrainerEnablerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignPoolConstrainerEnablers | ||
Description |
Tests if this user can alter pool constrainer
enabler/pool constrainer 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 | assignPoolConstrainerEnablerToPoolConstrainer | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | poolConstrainerEnablerId | the Id of the PoolConstrainerEnabler |
osid.id.Id | poolConstrainerId | the Id of the PoolConstrainer | |
Errors | ALREADY_EXISTS | poolConstrainerEnablerId is already applied to
poolConstrainerId | |
NOT_FOUND | poolConstrainerEnablerId or poolConstrainerId
not found | ||
NULL_ARGUMENT | poolConstrainerEnablerId or poolConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPoolConstrainerEnablerFromPoolConstrainer | ||
Description |
Removes a | ||
Parameters | osid.id.Id | poolConstrainerEnablerId | the Id of the PoolConstrainerEnabler |
osid.id.Id | poolConstrainerId | the Id of the PoolConstrainer | |
Errors | NOT_FOUND | poolConstrainerEnablerId or poolConstrainerId
not found or poolConstrainerEnablerId not applied to
poolConstrainerId | |
NULL_ARGUMENT | poolConstrainerEnablerId or poolConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequencePoolConstrainerEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if PoolConstrainerEnabler ordering is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | movePoolConstrainerEnablerAhead | ||
Description |
Reorders pool constrainer enablers for a pool constrainer by moving the specified pool constrainer enabler in front of a reference pool constrainer enabler. | ||
Parameters | osid.id.Id | poolConstrainerEnablerId | the Id of a PoolConstrainerEnabler |
osid.id.Id | poolConstrainerId | the Id of a PoolConstrainer | |
osid.id.Id | referenceId | the reference pool constrainer enabler Id | |
Errors | NOT_FOUND | poolConstrainerEnablerId, poolConstrainerId, or
referenceId not found or, poolConstrainerEnablerId or
referenceId not related to poolConstrainerId | |
NULL_ARGUMENT | poolConstrainerEnablerId, poolConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | movePoolConstrainerEnablerBehind | ||
Description |
Reorders pool constrainer enablers for a pool constrainer by moving the specified pool constrainer enabler behind a reference pool constrainer enabler. | ||
Parameters | osid.id.Id | poolConstrainerEnablerId | the Id of a PoolConstrainerEnabler |
osid.id.Id | poolConstrainerId | the Id of a PoolConstrainer | |
osid.id.Id | referenceId | the reference pool constrainer enabler Id | |
Errors | NOT_FOUND | poolConstrainerEnablerId, poolConstrainerId, or
referenceId not found or, poolConstrainerEnablerId or
referenceId not related to poolConstrainerId | |
NULL_ARGUMENT | poolConstrainerEnablerId, poolConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderPoolConstrainerEnablers | ||
Description |
Reorders a set of pool constrainer enablers for a pool constrainer. | ||
Parameters | osid.id.Id[] | poolConstrainerEnablerIds | the Ids for a set of PoolConstrainerEnablers |
osid.id.Id | poolConstrainerId | the Id of a PoolConstrainer | |
Errors | NOT_FOUND | poolConstrainerId not found or, a
poolConstrainerEnablerId not related to poolConstrainerId
| |
NULL_ARGUMENT | poolConstrainerEnablerIds or poolConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |