| Interface | osid.inquiry.rules.AuditEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| 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 | canAssignAuditEnablers | ||
| Description | 
                     Tests if this user can alter audit enabler/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 | assignAuditEnablerToAudit | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | auditEnablerId | the  Id  of the  AuditEnabler   | 
osid.id.Id | auditId | the  Id  of the  Audit   | |
| Errors | ALREADY_EXISTS |  auditEnablerId  already applied to  auditId   |                 |
| NOT_FOUND |  auditEnablerId  or  auditId  not found  |                 ||
| NULL_ARGUMENT |  auditEnablerId  or  auditId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuditEnablerFromAudit | ||
| Description | 
                     Removes an   | ||
| Parameters | osid.id.Id | auditEnablerId | the  Id  of the  AuditEnabler   | 
osid.id.Id | auditId | the  Id  of the  Audit   | |
| Errors | NOT_FOUND |  auditEnablerId  or  auditId  not found or  
auditEnablerId  not applied to  auditId   |                 |
| NULL_ARGUMENT |  auditEnablerId  or  auditId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceAuditEnablers | ||
| Description | 
                     Tests if this user can order   | ||
| Return | boolean |  false  if  AuditEnabler  ordering is not 
authorized,  true  otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditEnablerAhead | ||
| Description | 
                     Reorders audit enablers for an audit by moving the specified audit enabler in front of a reference audit enabler.  | ||
| Parameters | osid.id.Id | auditEnablerId | the  Id  of an  AuditEnabler   | 
osid.id.Id | auditId | the  Id  of an  Audit   | |
osid.id.Id | referenceId | the reference audit enabler  Id   | |
| Errors | NOT_FOUND |  auditEnablerId, auditId,  or  referenceId  not 
found or,  auditEnablerId  or  referenceId  not 
related to  auditId   |                 |
| NULL_ARGUMENT |  auditEnablerId, auditId,  or  referenceId  is 
 null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditEnablerBehind | ||
| Description | 
                     Reorders audit enablers for an inquiry by moving the specified audit enabler behind a reference audit enabler.  | ||
| Parameters | osid.id.Id | auditEnablerId | the  Id  of an  AuditEnabler   | 
osid.id.Id | auditId | the  Id  of an  Audit   | |
osid.id.Id | referenceId | the reference audit enabler  Id   | |
| Errors | NOT_FOUND |  auditEnablerId, auditId,  or  referenceId  not 
found or,  auditEnablerId  or  referenceId  not 
related to  auditId   |                 |
| NULL_ARGUMENT |  auditEnablerId, auditId,  or  referenceId  is 
 null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAuditEnablers | ||
| Description | 
                     Reorders a set of audit enablers for an audit.  | ||
| Parameters | osid.id.Id[] | auditEnablerIds | the  Ids  for a set of  AuditEnablers   | 
osid.id.Id | auditId | the  Id  of an  Audit   | |
| Errors | NOT_FOUND |  inquiryConstraienrId  not found or, an  auditEnablerId 
 not related to  auditId   |                 |
| NULL_ARGUMENT |  auditEnablerIds  or  auditId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |