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

This session provides methods to apply AuditConstrainers to Audits. Multiple AuditConstrainers applied to an Audit may be sequenced such that the first positive evaluation results in the AuditConstrainer 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.
MethodcanAssignAuditConstrainers
Description

Tests if this user can alter audit constrainer/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.
MethodassignAuditConstrainerToAudit
Description

Adds an existing AuditConstrainer to an Audit.

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

Removes an existing AuditConstrainer from an Audit.

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

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

Reorders audit constrainers for an audit by moving the specified audit constrainer in front of a reference audit constrainer.

Parametersosid.id.IdauditConstrainerId the Id of the AuditConstrainer
osid.id.IdauditId the Id of the Audit
osid.id.IdreferenceId the reference audit constrainer Id
ErrorsNOT_FOUND auditConstrainerId, auditId, or referenceId not found or, auditConstrainerId or referenceId not related to auditId
NULL_ARGUMENT auditConstrainerId, auditId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodmoveAuditConstrainerBehind
Description

Reorders audit constrainers for an audit by moving the specified audit constrainer behind a reference audit constrainer.

Parametersosid.id.IdauditConstrainerId the Id of the AuditConstrainer
osid.id.IdauditId the Id of the Audit
osid.id.IdreferenceId the reference audit constrainer Id
ErrorsNOT_FOUND auditConstrainerId, auditId, or referenceId not found or, auditConstrainerId or referenceId not related to auditId
NULL_ARGUMENT auditConstrainerId, auditId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodorderAuditConstrainers
Description

Reorders a set of audit constrainers for an audit.

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