| Interface | osid.inquiry.ResponseInquestAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignResponses | ||
| Description |
Tests if this user can alter response/inquest 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 response is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignResponsesToInquest | ||
| Description |
Tests if this user can alter response/inquest 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 | inquestId | the Id of the Inquest |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | inquestId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableInquestIds | ||
| Description |
Gets a list of inquests including and under the given inquest node in which any response can be assigned. | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.id.IdList | list of assignable inquest Ids | |
| Errors | NULL_ARGUMENT | inquestId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableInquestIdsForResponse | ||
| Description |
Gets a list of inquests including and under the given inquest node in which a specific response can be assigned. | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
osid.id.Id | responseId | the Id of the Response | |
| Return | osid.id.IdList | list of assignable inquest Ids | |
| Errors | NULL_ARGUMENT | inquestId or responseId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignResponseToInquest | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | responseId | the Id of the Response |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | ALREADY_EXISTS | responseId is already assigned to inquestId | |
| NOT_FOUND | responseId or inquestId not found | ||
| NULL_ARGUMENT | responseId or inquestId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignResponseFromInquest | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | responseId | the Id of the Response |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | NOT_FOUND | responseId or inquestId not found or
responseId not assigned to inquestId | |
| NULL_ARGUMENT | responseId or inquestId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignResponseToInquest | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | responseId | the Id of the Response |
osid.id.Id | fromInquestId | the Id of the current Inquest | |
osid.id.Id | toInquestId | the Id of the destination Inquest | |
| Errors | NOT_FOUND | responseId, fromInquestId, or toInquestId not
found or responseId not mapped to fromInquestId | |
| NULL_ARGUMENT | responseId, fromInquestId, or toInquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |