| Interface | osid.resourcing.rules.AvailabilityEnablerFoundryAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.resourcing.rules.ResourcingRulesManager | ||
osid.resourcing.rules.ResourcingRulesProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of an | ||
| Method | canAssignAvailabilityEnablers | ||
| Description |
Tests if this user can alter availability
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 | canAssignAvailabilityEnablersToFoundry | ||
| Description |
Tests if this user can alter availability
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 availability 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 | getAssignableFoundryIdsForAvailabilityEnabler | ||
| Description |
Gets a list of foundries including and under the given foundry node in which a specific availability enabler can be assigned. | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.id.Id | availabilityEnablerId | the Id of the AvailabilityEnabler | |
| Return | osid.id.IdList | list of assignable foundry Ids | |
| Errors | NULL_ARGUMENT | foundryId or availabilityEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAvailabilityEnablerToFoundry | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | availabilityEnablerId | the Id of the AvailabilityEnabler |
osid.id.Id | foundryId | the Id of the Foundry | |
| Errors | ALREADY_EXISTS | availabilityEnablerId is already assigned to
foundryId | |
| NOT_FOUND | availabilityEnablerId or foundryId not found | ||
| NULL_ARGUMENT | availabilityEnablerId or foundryId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAvailabilityEnablerFromFoundry | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | availabilityEnablerId | the Id of the AvailabilityEnabler |
osid.id.Id | foundryId | the Id of the Foundry | |
| Errors | NOT_FOUND | availabilityEnablerId or foundryId not found or
availabilityEnablerId not assigned to foundryId | |
| NULL_ARGUMENT | availabilityEnablerId or foundryId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignAvailabilityEnablerToFoundry | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | availabilityEnablerId | the Id of the AvailabilityEnabler |
osid.id.Id | fromFoundryId | the Id of the current Foundry | |
osid.id.Id | toFoundryId | the Id of the destination Foundry | |
| Errors | ALREADY_EXISTS | availabilityEnablerId already assigned to
toFoundryId | |
| NOT_FOUND | availabilityEnablerId, fromFoundryId , or
toFoundryId not found or availabilityEnablerId not
mapped to fromFoundryId | ||
| NULL_ARGUMENT | availabilityEnablerId, fromFoundryId , or
toFoundryId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |