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

This session provides methods to re-assign Checks to Engine mappings. A Check may appear in multiple Engine objects and removing the last reference to a Check is the equivalent of deleting it. Each Engine may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Check to another Engine is not a copy operation (eg: does not change its Id ).

MethodcanAssignChecks
Description

Tests if this user can alter hold/engine mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known instruction 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
CompliancemandatoryThis method must be implemented.
MethodcanAssignChecksToEngine
Description

Tests if this user can alter hold/engine mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known instruction 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.

Parametersosid.id.IdengineIdthe Id of the Engine
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT engineId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableEngineIds
Description

Gets a list of engines including and under the given engine node in which any check can be assigned.

Parametersosid.id.IdengineIdthe Id of the Engine
Returnosid.id.IdListlist of assignable engine Ids
ErrorsNULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableEngineIdsForCheck
Description

Gets a list of engines including and under the given engine node in which a specific check can be assigned.

Parametersosid.id.IdengineIdthe Id of the Engine
osid.id.IdcheckIdthe Id of the Check
Returnosid.id.IdListlist of assignable engine Ids
ErrorsNULL_ARGUMENT engineId or checkId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignCheckToEngine
Description

Adds an existing Check to a Engine.

Parametersosid.id.IdcheckIdthe Id of the Check
osid.id.IdengineIdthe Id of the Engine
ErrorsALREADY_EXISTS checkId is already assigned to engineId
NOT_FOUND checkId or engineId not found
NULL_ARGUMENT checkId or engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCheckFromEngine
Description

Removes a Check from a Engine.

Parametersosid.id.IdcheckIdthe Id of the Check
osid.id.IdengineIdthe Id of the Engine
ErrorsNOT_FOUND checkId or engineId not found or checkId not assigned to engineId
NULL_ARGUMENT checkId or engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.