| Interface | osid.resource.ResourceRelationshipBinAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
| Method | canAssignResourceRelationships | ||
| Description |
Tests if this user can alter resource relationship/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 | canAssignResourceRelationshipsToBin | ||
| Description |
Tests if this user can alter resource relationship/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 relationship 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 | getAssignableBinIdsForResourceRelationship | ||
| Description |
Gets a list of bins including and under the given bin node in which a specific resource relationship can be assigned. | ||
| Parameters | osid.id.Id | binId | the Id of the Bin |
osid.id.Id | resourceRelationshipId | the Id of the ResourceRelationship | |
| Return | osid.id.IdList | list of assignable bin Ids | |
| Errors | NULL_ARGUMENT | binId or resourceRelationshipId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignResourceRelationshipToBin | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | resourceRelationshipId | the Id of the ResourceRelationship |
osid.id.Id | binId | the Id of the Bin | |
| Errors | ALREADY_EXISTS | resourceRelationshipId is already assigned to binId
| |
| NOT_FOUND | resourceRelationshipId or binId not found | ||
| NULL_ARGUMENT | resourceRelationshipId or binId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignResourceRelationshipFromBin | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | resourceRelationshipId | the Id of the ResourceRelationship |
osid.id.Id | binId | the Id of the Bin | |
| Errors | NOT_FOUND | resourceRelationshipId or binId not found or
resourceRelationshipId not assigned to binId | |
| NULL_ARGUMENT | resourceRelationshipId or binId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |