Interface | osid.resourcing.rules.CommissionEnablerFoundryAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCommissionEnablers | ||
Description |
Tests if this user can alter commission enabler/foundry
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 | canAssignCommissionEnablersToFoundry | ||
Description |
Tests if this user can alter commission enabler/foundry
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
| ||
Parameters | osid.id.Id | foundryId | the Id of the Foundry |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | foundryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableFoundryIds | ||
Description |
Gets a list of foundries including and under the given foundry node in which any commission enabler can be assigned. | ||
Parameters | osid.id.Id | foundryId | the Id of the Foundry |
Return | osid.id.IdList | list of assignable foundry Ids | |
Errors | NULL_ARGUMENT | foundryId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableFoundryIdsForCommissionEnabler | ||
Description |
Gets a list of foundries including and under the given foundry node in which a specific commission enabler can be assigned. | ||
Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.id.Id | commissionEnablerId | the Id of the CommissionEnabler | |
Return | osid.id.IdList | list of assignable foundry Ids | |
Errors | NULL_ARGUMENT | foundryId or commissionEnablerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCommissionEnablerToFoundry | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | commissionEnablerId | the Id of the CommissionEnabler |
osid.id.Id | foundryId | the Id of the Foundry | |
Errors | ALREADY_EXISTS | ccommissionEnablerId is already assigned to foundryId
| |
NOT_FOUND | ccommissionEnablerId or foundryId not found | ||
NULL_ARGUMENT | commissionEnablerId or foundryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCommissionEnablerFromFoundry | ||
Description |
Removes a | ||
Parameters | osid.id.Id | commissionEnablerId | the Id of the CommissionEnabler |
osid.id.Id | foundryId | the Id of the Foundry | |
Errors | NOT_FOUND | commissionEnablerId or foundryId not found or
commissionEnablerId not assigned to foundryId | |
NULL_ARGUMENT | commissionEnablerId or foundryId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |