| Interface | osid.inquiry.rules.AuditConstrainerInquestAssignmentSession | ||
|---|---|---|---|
| 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 | canAssignAuditConstrainers | ||
| Description |
Tests if this user can alter audit constrainer/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 | canAssignAuditConstrainerToInquest | ||
| Description |
Tests if this user can alter audit constrainer/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 constrainer 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 | getAssignableInquestIdsForAuditConstrainer | ||
| Description |
Gets a list of inquests including and under the given inquest node in which a specific audit constrainer can be assigned. | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer | |
| Return | osid.id.IdList | list of assignable inquest Ids | |
| Errors | NULL_ARGUMENT | inquestId or auditConstrainerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAuditConstrainerToInquest | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | ALREADY_EXISTS | auditConstrainerId is already assigned to
inquestId | |
| NOT_FOUND | auditConstrainerId or inquestId not found | ||
| NULL_ARGUMENT | auditConstrainerId or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuditConstrainerFromInquest | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | auditConstrainerId | the Id of the AuditConstraienr |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | NOT_FOUND | auditConstrainerId or inquestId not found or
auditConstrainerId not assigned to inquestId | |
| NULL_ARGUMENT | auditConstrainerId or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignAuditConstrainerToInquest | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer |
osid.id.Id | fromInquestId | the Id of the current Inquest | |
osid.id.Id | toInquestId | the Id of the destination Inquest | |
| Errors | ALREADY_EXISTS | auditConstrainerId already assigned to
toInquestId | |
| NOT_FOUND | auditConstrainerId, fromInquestId, or
toInquestId not found or auditConstrainerId not
mapped to fromInquestId | ||
| NULL_ARGUMENT | auditConstrainerId, fromInquestId, or
toInquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |