| Interface | osid.inquiry.rules.AuditProcessorEnablerRuleApplicationSession | ||
|---|---|---|---|
| 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 | canAssignAuditProcessorEnablers | ||
| Description |
Tests if this user can alter audit processor
enabler/audit processor 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 | assignAuditProcessorEnablerToAuditProcessor | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler |
osid.id.Id | auditProcessorId | the Id of the AuditProcessor | |
| Errors | ALREADY_EXISTS | auditProcessorEnablerId already applied to
auditProcessorId | |
| NOT_FOUND | auditProcessorEnablerId or auditProcessorId not
found | ||
| NULL_ARGUMENT | auditProcessorEnablerId or auditProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuditProcessorEnablerFromAuditProcessor | ||
| Description |
Removes an existing | ||
| Parameters | osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler |
osid.id.Id | auditProcessorId | the Id of the AuditProcessor | |
| Errors | NOT_FOUND | auditProcessorEnablerId or auditProcessorId not
found or auditProcessorEnablerId already applied to
auditProcessorId | |
| NULL_ARGUMENT | auditProcessorEnablerId or auditProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceAuditProcessorEnablers | ||
| Description |
Tests if this user can order
| ||
| Return | boolean | false if AuditProcessorEnabler ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditProcessorEnablerAhead | ||
| Description |
Reorders audit processor enablers for an audit processor by moving the specified audit processor enabler in front of a reference audit processor enabler. | ||
| Parameters | osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler |
osid.id.Id | auditProcessorId | the Id of the AuditProcessor | |
osid.id.Id | referenceId | the reference audit processor enabler Id | |
| Errors | NOT_FOUND | auditProcessorEnablerId auditProcessorId, or
referenceId not found or, auditProcessorEnablerId or
referenceId not related to auditProcessorId | |
| NULL_ARGUMENT | auditProcessorEnablerId, auditProcessorId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditProcessorEnablerBehind | ||
| Description |
Reorders audit processor enablers for an audit processor by moving the specified audit processor enabler behind a reference audit processor enabler. | ||
| Parameters | osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler |
osid.id.Id | auditProcessorId | the Id of the AuditProcessor | |
osid.id.Id | referenceId | the reference audit processor Id | |
| Errors | NOT_FOUND | auditProcessorEnablerId auditProcessorId, or
referenceId not found or, auditProcessorEnablerId or
referenceId not related to auditProcessorId | |
| NULL_ARGUMENT | auditProcessorEnablerId, auditProcessorId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAuditProcessorEnablers | ||
| Description |
Reorders a set of audit processor enablers for an audit processor. | ||
| Parameters | osid.id.Id[] | auditProcessorEnablerIds | the Ids for a set of AuditProcessorEnablers |
osid.id.Id | auditProcessorId | the Id of the AuditProcessor | |
| Errors | NOT_FOUND | auditProcessorId not found or, an
auditProcessorEnablerId not related to
auditProcessorId | |
| NULL_ARGUMENT | auditProcessorEnablerIds or auditProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |