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

This session provides methods to retrieve Check to Engine mappings. A Check 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
MethodcanLookupCheckEngineMappings
Description

Tests if this user can perform lookups of hold/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.
MethoduseComparativeCheckEngineView
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.
MethodusePlenaryCheckEngineView
Description

A complete view of the Check and Engine 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.
MethodgetCheckIdsByEngine
Description

Gets the list of Check Ids associated with a Engine.

Parametersosid.id.IdengineId Id of the Engine
Returnosid.id.IdListlist of related check 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.
MethodgetChecksByEngine
Description

Gets the list of Checks associated with a Engine.

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

Gets the list of Check Ids corresponding to a list of Engines.

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

Gets the list of Check corresponding to a list of Engines.

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

Gets the Engine Ids mapped to a Check.

Parametersosid.id.IdcheckId Id of a Check
Returnosid.id.IdListlist of engines
ErrorsNOT_FOUND checkId is not found
NULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEnginesByCheck
Description

Gets the Engines mapped to a Check.

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