| Interface | osid.resource.ResourceBinAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
| Method | canAssignResources | ||
| Description |
Tests if this user can alter resource/bin 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 | canAssignResourcesToBin | ||
| Description |
Tests if this user can alter resource/bin 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 | binId | the Id of the Bin |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | binId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableBinIds | ||
| Description |
Gets a list of bins including and under the given bin node in which any resource can be assigned. | ||
| Parameters | osid.id.Id | binId | the Id of the Bin |
| Return | osid.id.IdList | list of assignable bin Ids | |
| Errors | NULL_ARGUMENT | binId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableBinIdsForResource | ||
| Description |
Gets a list of bins including and under the given bin node in which a specific resource can be assigned. | ||
| Parameters | osid.id.Id | binId | the Id of the Bin |
osid.id.Id | resourceId | the Id of the Resource | |
| Return | osid.id.IdList | list of assignable bin Ids | |
| Errors | NULL_ARGUMENT | binId or resourceId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignResourceToBin | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | resourceId | the Id of the Resource |
osid.id.Id | binId | the Id of the Bin | |
| Errors | ALREADY_EXISTS | resourceId is already assigned to binId | |
| NOT_FOUND | resourceId or binId not found | ||
| NULL_ARGUMENT | resourceId or binId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignResourceFromBin | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | resourceId | the Id of the Resource |
osid.id.Id | binId | the Id of the Bin | |
| Errors | NOT_FOUND | resourceId or binId not found or
resourceId not assigned to binId | |
| NULL_ARGUMENT | resourceId or binId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |