| Interface | osid.resource.ResourceAgentAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign | ||
| Method | getBinId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Bin Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBin | ||
| Description |
Gets the | ||
| Return | osid.resource.Bin | the Bin associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignAgents | ||
| Description |
Tests if this user can alter resource/agent 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 | canAssignAgentsToResource | ||
| Description |
Tests if this user can alter resource/agent mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known location methods in this session will result in a
| ||
| Parameters | osid.id.Id | resourceId | the Id of the Resource |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | resourceId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAgentToResource | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | agentId | the Id of the Agent |
osid.id.Id | resourceId | the Id of the Resource | |
| Errors | ALREADY_EXISTS | agentId is already assigned to resourceId | |
| NOT_FOUND | agentId or resourceId not found | ||
| NULL_ARGUMENT | agentId or resourceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAgentFromResource | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | agentId | the Id of the Agent |
osid.id.Id | resourceId | the Id of the Resource | |
| Errors | NOT_FOUND | agentId or resourceId not found or
agentId not assigned to resourceId | |
| NULL_ARGUMENT | agentId or resourceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |