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