| Interface | osid.inquiry.rules.AuditConstrainerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods to apply
| ||
| Method | getInquestId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Inquest Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquest | ||
| Description |
Gets the | ||
| Return | osid.inquiry.Inquest | the inquest | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignAuditConstrainers | ||
| Description |
Tests if this user can alter audit constrainer/audit
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 | assignAuditConstrainerToAudit | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer |
osid.id.Id | auditId | the Id of the Audit | |
| Errors | ALREADY_EXISTS | auditConstrainerId already applied to auditId | |
| NOT_FOUND | auditConstrainerId or auditId not found | ||
| NULL_ARGUMENT | auditConstrainerId or auditId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuditConstrainerFromAudit | ||
| Description |
Removes an existing | ||
| Parameters | osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer |
osid.id.Id | auditId | the Id of the Audit | |
| Errors | NOT_FOUND | auditConstrainerId or auditId not found or
auditConstrainerId already applied to auditId | |
| NULL_ARGUMENT | auditConstrainerId or auditId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceAuditConstrainers | ||
| Description |
Tests if this user can order
| ||
| Return | boolean | false if AuditConstrainer ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditConstrainerAhead | ||
| Description |
Reorders audit constrainers for an audit by moving the specified audit constrainer in front of a reference audit constrainer. | ||
| Parameters | osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer |
osid.id.Id | auditId | the Id of the Audit | |
osid.id.Id | referenceId | the reference audit constrainer Id | |
| Errors | NOT_FOUND | auditConstrainerId, auditId, or referenceId not
found or, auditConstrainerId or referenceId not
related to auditId | |
| NULL_ARGUMENT | auditConstrainerId, auditId, or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditConstrainerBehind | ||
| Description |
Reorders audit constrainers for an audit by moving the specified audit constrainer behind a reference audit constrainer. | ||
| Parameters | osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer |
osid.id.Id | auditId | the Id of the Audit | |
osid.id.Id | referenceId | the reference audit constrainer Id | |
| Errors | NOT_FOUND | auditConstrainerId, auditId, or referenceId not
found or, auditConstrainerId or referenceId not
related to auditId | |
| NULL_ARGUMENT | auditConstrainerId, auditId, or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAuditConstrainers | ||
| Description |
Reorders a set of audit constrainers for an audit. | ||
| Parameters | osid.id.Id[] | auditConstrainerIds | the Ids for a set of AuditConstrainers |
osid.id.Id | auditId | the Id of the Audit | |
| Errors | NOT_FOUND | auditId not found or, an auditConstrainerId not
related to auditId | |
| NULL_ARGUMENT | auditConstrainerIds or auditId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |