| Interface | osid.resourcing.EffortFoundryAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignEfforts | ||
| Description |
Tests if this user can alter effort/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 resourcing is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignEffortsToFoundry | ||
| Description |
Tests if this user can alter effort/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 resourcing 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 effort 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 | getAssignableFoundryIdsForEffort | ||
| Description |
Gets a list of foundries including and under the given foundry node in which a specific effort can be assigned. | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.id.Id | effortId | the Id of the Effort | |
| Return | osid.id.IdList | list of assignable foundry Ids | |
| Errors | NULL_ARGUMENT | foundryId or effortId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignEffortToFoundry | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | effortId | the Id of the Effort |
osid.id.Id | foundryId | the Id of the Foundry | |
| Errors | NOT_FOUND | effortId or foundryId not found | |
| NULL_ARGUMENT | effortId or foundryId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignEffortFromFoundry | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | effortId | the Id of the Effort |
osid.id.Id | foundryId | the Id of the Foundry | |
| Errors | NOT_FOUND | effortId or foundryId not found | |
| NULL_ARGUMENT | effortId or foundryId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |