OSID Logo
OSID Specifications
inquiry rules package
Version 3.1.0
Interfaceosid.inquiry.rules.AuditProcessorRuleApplicationSession
Implementsosid.OsidSession
Used Byosid.inquiry.rules.InquiryRulesManager
osid.inquiry.rules.InquiryRulesProxyManager
Description

This session provides methods to apply AuditProcessors to Audits. Multiple AuditProcessors applied to an Audit may be sequenced such that the first positive evaluation results in the AuditProcessor used.

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Id the Inquest Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquest the inquest
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanAssignAuditProcessors
Description

Tests if this user can alter audit processor/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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodassignAuditProcessorToAudit
Description

Adds an existing AuditProcessor to an Audit.

Parametersosid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdauditId the Id of the Audit
ErrorsALREADY_EXISTS auditProcessorId already applied to auditId
NOT_FOUND auditProcessorId or auditId not found
NULL_ARGUMENT auditProcessorId or auditId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignAuditProcessorFromAudit
Description

Removes an existing AuditProcessor from an Audit.

Parametersosid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdauditId the Id of the Audit
ErrorsNOT_FOUND auditProcessorId or auditId not found or auditProcessorId already applied to auditId
NULL_ARGUMENT auditProcessorId or auditId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSequenceAuditProcessors
Description

Tests if this user can order AuditProcessors. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if AuditProcessor ordering is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodmoveAuditProcessorAhead
Description

Reorders audit processors for an audit by moving the specified audit processor in front of a reference audit processor.

Parametersosid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdauditId the Id of the Audit
osid.id.IdreferenceId the reference audit processor Id
ErrorsNOT_FOUND auditProcessorId auditId, or referenceId not found or, auditProcessorId or referenceId not related to auditId
NULL_ARGUMENT auditProcessorId, auditId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodmoveAuditProcessorBehind
Description

Reorders audit processors for an audit by moving the specified audit processor behind a reference audit processor.

Parametersosid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdauditId the Id of the Audit
osid.id.IdreferenceId the reference audit processor Id
ErrorsNOT_FOUND auditProcessorId, auditId, or referenceId not found or, auditProcessorId or referenceId not related to auditId
NULL_ARGUMENT auditProcessorId, auditId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodorderAuditProcessors
Description

Reorders a set of audit processors for an audit.

Parametersosid.id.Id[]auditProcessorIds the Ids for a set of AuditProcessors
osid.id.IdauditId the Id of the Audit
ErrorsNOT_FOUND auditId not found or, an auditProcessorId not related to auditId
NULL_ARGUMENT auditProcessorIds or auditId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.