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

This session provides methods to re-assign Agendas to Engine mappings. An Agenda may appear in multiple Engine objects and removing the last reference to an Agenda 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 an Agenda to another Engine is not a copy operation (eg: does not change its Id ).

MethodcanAssignAgendas
Description

Tests if this user can alter agenda/engine 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 check is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignAgendasToEngine
Description

Tests if this user can alter agenda/engine 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.

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 agenda 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.
MethodgetAssignableEngineIdsForAgenda
Description

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

Parametersosid.id.IdengineIdthe Id of the Engine
osid.id.IdagendaIdthe Id of the Agenda
Returnosid.id.IdListlist of assignable engine Ids
ErrorsNULL_ARGUMENT engineId or agendaId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAgendaToEngine
Description

Adds an existing Agenda to a Engine.

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

Removes an Agenda from a Engine.

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