Interface | osid.inquiry.AuditInquestAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignAudits | ||
Description |
Tests if this user can alter audit/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 | canAssignAuditsToInquest | ||
Description |
Tests if this user can alter audit/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 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 | getAssignableInquestIdsForAudit | ||
Description |
Gets a list of inquests including and under the given inquest node in which a specific audit can be assigned. | ||
Parameters | osid.id.Id | inquestId | the Id of the Inquest |
osid.id.Id | auditId | the Id of the Audit | |
Return | osid.id.IdList | list of assignable inquest Ids | |
Errors | NULL_ARGUMENT | inquestId or auditId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignAuditToInquest | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | auditId | the Id of the Audit |
osid.id.Id | inquestId | the Id of the Inquest | |
Errors | ALREADY_EXISTS | auditId is already assigned to inquestId | |
NOT_FOUND | auditId or inquestId not found | ||
NULL_ARGUMENT | auditId or inquestId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignAuditFromInquest | ||
Description |
Removes an | ||
Parameters | osid.id.Id | auditId | the Id of the Audit |
osid.id.Id | inquestId | the Id of the Inquest | |
Errors | NOT_FOUND | auditId or inquestId not found or
auditId not assigned to inquestId | |
NULL_ARGUMENT | auditId or inquestId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignAuditToInquest | ||
Description |
Moves an | ||
Parameters | osid.id.Id | auditId | the Id of the Audit |
osid.id.Id | fromInquestId | the Id of the current Inquest | |
osid.id.Id | toInquestId | the Id of the destination Inquest | |
Errors | NOT_FOUND | auditId, fromInquestId, or toInquestId not
found or auditiId not mapped to fromInquestId | |
NULL_ARGUMENT | auditId, fromInquestId, or toInquestId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |