Interface | osid.resourcing.CommissionFoundryAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCommissions | ||
Description |
Tests if this user can alter commission/foundry
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known availability 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 | canAssignCommissionsToFoundry | ||
Description |
Tests if this user can alter commission/foundry
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known availability 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 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 | getAssignableFoundryIdsForCommission | ||
Description |
Gets a list of foundries including and under the given foundry node in which a specific commission can be assigned. | ||
Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.id.Id | commissionId | the Id of the Commission | |
Return | osid.id.IdList | list of assignable foundry Ids | |
Errors | NULL_ARGUMENT | foundryId or commissionId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCommissionToFoundry | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | commissionId | the Id of the Commission |
osid.id.Id | foundryId | the Id of the Foundry | |
Errors | NOT_FOUND | commissionId or foundryId not found | |
NULL_ARGUMENT | commissionId or foundryId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCommissionFromFoundry | ||
Description |
Removes a | ||
Parameters | osid.id.Id | commissionId | the Id of the Commission |
osid.id.Id | foundryId | the Id of the Foundry | |
Errors | NOT_FOUND | commissionId or foundryId not found | |
NULL_ARGUMENT | commissionId or foundryId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |