| Interface | osid.inquiry.rules.AuditProcessorInquestAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of an | ||
| Method | canAssignAuditProcessors | ||
| Description |
Tests if this user can alter audit processor/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 mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignAuditProcessorToInquest | ||
| Description |
Tests if this user can alter audit processor/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 audit processor 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 | getAssignableInquestIdsForAuditProcessor | ||
| Description |
Gets a list of inquests including and under the given inquest node in which a specific audit processor can be assigned. | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
osid.id.Id | auditProcessorId | the Id of the AuditProcessor | |
| Return | osid.id.IdList | list of assignable inquest Ids | |
| Errors | NULL_ARGUMENT | inquestId or auditProcessorId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAuditProcessorToInquest | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auditProcessorId | the Id of the AuditProcessor |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | ALREADY_EXISTS | auditProcessorId is already assigned to
inquestId | |
| NOT_FOUND | auditProcessorId or inquestId not found | ||
| NULL_ARGUMENT | auditProcessorId or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuditProcessorFromInquest | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | auditProcessorId | the Id of the AuditProcessor |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | NOT_FOUND | auditProcessorId or inquestId not found or
auditProcessorId not assigned to inquestId | |
| NULL_ARGUMENT | auditProcessorId or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignAuditProcessorToInquest | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | auditProcessorId | the Id of the AuditProcessor |
osid.id.Id | fromInquestId | the Id of the current Inquest | |
osid.id.Id | toInquestId | the Id of the destination Inquest | |
| Errors | ALREADY_EXISTS | auditProcessorId already assigned to toInquestId | |
| NOT_FOUND | auditProcessorId, fromInquestId, or toInquestId
not found or auditProcessorId not mapped to
fromInquestId | ||
| NULL_ARGUMENT | auditProcessorId, fromInquestId, or toInquestId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |