| Interface | osid.inquiry.InquiryInquestAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of an | ||
| Method | canAssignInquiries | ||
| Description |
Tests if this user can alter inquiry/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 control is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignInquiriesToInquest | ||
| Description |
Tests if this user can alter inquiry/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 control 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 inquiry 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 | getAssignableInquestIdsForInquiry | ||
| Description |
Gets a list of inquests including and under the given inquest node in which a specific inquiry can be assigned. | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
osid.id.Id | inquiryId | the Id of the Inquiry | |
| Return | osid.id.IdList | list of assignable inquest Ids | |
| Errors | NULL_ARGUMENT | inquestId or inquiryId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignInquiryToInquest | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | inquiryId | the Id of the Inquiry |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | ALREADY_EXISTS | inquiryId is slready assigned to inquestId | |
| NOT_FOUND | inquiryId or inquestId not found | ||
| NULL_ARGUMENT | inquiryId or inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignInquiryFromInquest | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | inquiryId | the Id of the Inquiry |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | NOT_FOUND | inquiryId or inquestId not found or
inquiryId not assigned to inquestId | |
| NULL_ARGUMENT | inquiryId or inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignInquiryToInquest | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | inquiryId | the Id of the Inquiry |
osid.id.Id | fromInquestId | the Id of the current Inquest | |
osid.id.Id | toInquestId | the Id of the destination Inquest | |
| Errors | NOT_FOUND | inquiryId, fromInquestId, or toInquestId not
found or inquiryId not mapped to fromInquestId | |
| NULL_ARGUMENT | inquiryId, fromInquestId, or toInquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |