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

This session provides methods to apply AuditProcessorEnablers to AuditProcessors. Multiple AuditProcessorEnablers applied to an AuditProcessor may be sequenced such that the first positive evaluation results in the AuditProcessorEnabler 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.
MethodcanAssignAuditProcessorEnablers
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 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.
MethodassignAuditProcessorEnablerToAuditProcessor
Description

Adds an existing AuditProcessorEnabler to an AuditProcessor.

Parametersosid.id.IdauditProcessorEnablerId the Id of the AuditProcessorEnabler
osid.id.IdauditProcessorId the Id of the AuditProcessor
ErrorsALREADY_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
Compliancemandatory This method must be implemented.
MethodunassignAuditProcessorEnablerFromAuditProcessor
Description

Removes an existing AuditProcessorEnabler from an AuditProcessor.

Parametersosid.id.IdauditProcessorEnablerId the Id of the AuditProcessorEnabler
osid.id.IdauditProcessorId the Id of the AuditProcessor
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodcanSequenceAuditProcessorEnablers
Description

Tests if this user can order AuditProcessorEnablers. 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 AuditProcessorEnabler ordering is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodmoveAuditProcessorEnablerAhead
Description

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

Parametersosid.id.IdauditProcessorEnablerId the Id of the AuditProcessorEnabler
osid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdreferenceId the reference audit processor enabler Id
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodmoveAuditProcessorEnablerBehind
Description

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

Parametersosid.id.IdauditProcessorEnablerId the Id of the AuditProcessorEnabler
osid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdreferenceId the reference audit processor Id
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodorderAuditProcessorEnablers
Description

Reorders a set of audit processor enablers for an audit processor.

Parametersosid.id.Id[]auditProcessorEnablerIds the Ids for a set of AuditProcessorEnablers
osid.id.IdauditProcessorId the Id of the AuditProcessor
ErrorsNOT_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
Compliancemandatory This method must be implemented.