OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.RuleEngineSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Rule to Engine mappings. A Rule may appear in multiple Engine objects. Each engine may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupRuleEngineMappings
Description

Tests if this user can perform lookups of rule/engine mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryRuleView
Description

A complete view of the Rule returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetRuleIdsByEngine
Description

Gets the list of Rule Ids associated with an Engine.

Parametersosid.id.IdengineId Id of the Engine
Returnosid.id.IdListlist of related rule Ids
ErrorsNOT_FOUND engineId is not found
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRulesByEngine
Description

Gets the list of Rules associated with an Engine.

Parametersosid.id.IdengineId Id of the Engine
Returnosid.rules.RuleListlist of related rules
ErrorsNOT_FOUND engineId is not found
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRuleIdsByEngines
Description

Gets the list of Rule Ids corresponding to a list of Engine objects.

Parametersosid.id.IdListengineIdslist of engine Ids
Returnosid.id.IdListlist of rule Ids
ErrorsNULL_ARGUMENT engineIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRulesByEngines
Description

Gets the list of Rules corresponding to a list of Engine objects.

Parametersosid.id.IdListengineIdslist of engine Ids
Returnosid.rules.RuleListlist of rules
ErrorsNULL_ARGUMENT engineIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEngineIdsByRule
Description

Gets the Engine Ids mapped to a Rule.

Parametersosid.id.IdruleId Id of a Rule
Returnosid.id.IdListlist of engines
ErrorsNOT_FOUND ruleId is not found
NULL_ARGUMENT ruleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEnginesByRule
Description

Gets the Engine objects mapped to a Rule.

Parametersosid.id.IdruleId Id of a Rule
Returnosid.rules.EngineListlist of engines
ErrorsNOT_FOUND ruleId is not found
NULL_ARGUMENT ruleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.