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

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

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

Adds an existing AuditConstrainerEnabler to an AuditConstrainer.

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

Removes an existing AuditConstrainerEnabler from an AuditConstrainer.

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

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

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

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

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

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

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

Parametersosid.id.Id[]auditConstrainerEnablerIds the Ids for a set of AuditConstrainerEnablers
osid.id.IdauditConstrainerId the Id of the AuditConstrainer
ErrorsNOT_FOUND auditConstrainerId not found or, an auditConstrainerEnablerId not related to auditConstrainerId
NULL_ARGUMENT auditConstrainerEnablerIds or auditConstrainerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.