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

This session provides methods to apply AuditEnablers to Audits. An Audit with multiple AuditEnablers means any positive rule evaluation across the enablers result in an effective Audit.

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.
MethodcanAssignAuditEnablers
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 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.
MethodassignAuditEnablerToAudit
Description

Adds an existing AuditEnabler to an Audit.

Parametersosid.id.IdauditEnablerId the Id of the AuditEnabler
osid.id.IdauditId the Id of the Audit
ErrorsALREADY_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
Compliancemandatory This method must be implemented.
MethodunassignAuditEnablerFromAudit
Description

Removes an AuditEnabler from an Audit.

Parametersosid.id.IdauditEnablerId the Id of the AuditEnabler
osid.id.IdauditId the Id of the Audit
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodcanSequenceAuditEnablers
Description

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

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

Parametersosid.id.IdauditEnablerId the Id of an AuditEnabler
osid.id.IdauditId the Id of an Audit
osid.id.IdreferenceId the reference audit enabler Id
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodmoveAuditEnablerBehind
Description

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

Parametersosid.id.IdauditEnablerId the Id of an AuditEnabler
osid.id.IdauditId the Id of an Audit
osid.id.IdreferenceId the reference audit enabler Id
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodorderAuditEnablers
Description

Reorders a set of audit enablers for an audit.

Parametersosid.id.Id[]auditEnablerIds the Ids for a set of AuditEnablers
osid.id.IdauditId the Id of an Audit
ErrorsNOT_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
Compliancemandatory This method must be implemented.