OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.RulesCheckManager
Implementsosid.OsidManager
osid.rules.check.RulesCheckProfile
Used Byosid.rules.RulesManager
Description

The check manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • AgendaSession: a session for evaluating agendas
  • AgendaEvaluationSession: a session for evaluating agendas with detailed results
  • AgendaLookupSession: a session to retrieve agendas
  • AgendaQuerySession: a session to query for agendas
  • AgendaSearchSession: a session to search for agendas
  • AgendaAdminSession: a session to create and delete agendas
  • AgendaNotificationSession: a session to receive notifications pertaining to agenda changes
  • AgendaEngineSession: a session to looking mappings of agendas to engines
  • AgendaEngineAssignmentSession: a session to manage agenda to engine mappings
  • AgendaEngineAssignmentSession: a session to manage dynamic engines of agendas
  • InstructionApplicabilitySession: a session to evaluate the applicability of instructions
  • InstructionLookupSession: a session to retrieve instructions
  • InstructionQuerySession: a session to query for instructions
  • InstructionSearchSession: a session to search for instructions
  • InstructionAdminSession: a session to create and delete instructions
  • InstructionNotificationSession: a session to receive notifications pertaining to instruction changes
  • InstructionEngineSession: a session to look up instruction engine mappings
  • InstructionEngineAssignmentSession: a session to manage instruction to engine mappings
  • InstructionSmartEngineSession: a session to manage dynamic engines of instructions
  • CheckEvaluationSession: a session to evaluate checks
  • CheckLookupSession: a session to retrieve checks
  • CheckQuerySession: a session to query for checks
  • CheckSearchSession: a session to search for checks
  • CheckAdminSession: a session to create and delete checks
  • CheckNotificationSession: a session to receive notifications pertaining to check changes
  • CheckEngineSession: a session to look up check engine mappings
  • CheckEngineAssignmentSession: a session to manage check to engine mappings
  • CheckSmartEngineSession: a session to manage dynamic engines of checks
MethodgetAgendaSession
Description

Gets the OsidSession associated with the agenda evaluation service.

Returnosid.rules.check.AgendaSession an AgendaSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgenda() is false
Complianceoptional This method must be implemented if supportsAgenda() is true.
MethodgetAgendaSessionForEngine
Description

Gets the OsidSession associated with the agenda evaluation service for the given engine.

Parametersosid.id.IdengineId the Id of the engine
Returnosid.rules.check.AgendaSession an AgendaSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgenda() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgenda() and supportsVisibleFederation() are true
MethodgetAgendaEvaluationSession
Description

Gets the OsidSession associated with the agenda evaluation service.

Returnosid.rules.check.AgendaEvaluationSession an AgendaEvaluationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaEvaluation() is false
Complianceoptional This method must be implemented if supportsAgendaEvaluation() is true.
MethodgetAgendaEvaluationSessionForEngine
Description

Gets the OsidSession associated with the agenda evaluation service for the given engine.

Parametersosid.id.IdengineId the Id of the engine
Returnosid.rules.check.AgendaEvaluationSession an AgendaEvaluationSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaEvaluation() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgendaEvaluation() and supportsVisibleFederation() are true
MethodgetAgendaLookupSession
Description

Gets the OsidSession associated with the agenda lookup service.

Returnosid.rules.check.AgendaLookupSession an AgendaLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaLookup() is false
Complianceoptional This method must be implemented if supportsAgendaLookup() is true.
MethodgetAgendaLookupSessionForEngine
Description

Gets the OsidSession associated with the agenda lookup service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.AgendaLookupSession an AgendaLookupSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgendaLookup() and supportsVisibleFederation() are true
MethodgetAgendaQuerySession
Description

Gets the OsidSession associated with the agenda query service.

Returnosid.rules.check.AgendaQuerySession an AgendaQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaQuery() is false
Complianceoptional This method must be implemented if supportsAgendaQuery() is true.
MethodgetAgendaQuerySessionForEngine
Description

Gets the OsidSession associated with the agenda query service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.AgendaQuerySession an AgendaQuerySession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgendaQuery() and supportsVisibleFederation() are true
MethodgetAgendaSearchSession
Description

Gets the OsidSession associated with the agenda search service.

Returnosid.rules.check.AgendaSearchSession an AgendaSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaSearch() is false
Complianceoptional This method must be implemented if supportsAgendaSearch() is true.
MethodgetAgendaSearchSessionForEngine
Description

Gets the OsidSession associated with the agenda search service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.AgendaSearchSession an AgendaSearchSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgendaSearch() and supportsVisibleFederation() are true
MethodgetAgendaAdminSession
Description

Gets the OsidSession associated with the agenda administration service.

Returnosid.rules.check.AgendaAdminSession an AgendaAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaAdmin() is false
Complianceoptional This method must be implemented if supportsAgendaAdmin() is true.
MethodgetAgendaAdminSessionForEngine
Description

Gets the OsidSession associated with the agenda administration service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.AgendaAdminSession an AgendaAdminSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgendaAdmin() and supportsVisibleFederation() are true
MethodgetAgendaNotificationSession
Description

Gets the OsidSession associated with the agenda notification service.

Parametersosid.rules.check.AgendaReceiveragendaReceiver the notification callback
Returnosid.rules.check.AgendaNotificationSession an AgendaNotificationSession
ErrorsNULL_ARGUMENT agendaReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaNotification() is false
Complianceoptional This method must be implemented if supportsAgendaNotification() is true.
MethodgetAgendaNotificationSessionForEngine
Description

Gets the OsidSession associated with the agenda notification service for the given engine.

Parametersosid.rules.check.AgendaReceiveragendaReceiver the notification callback
osid.id.IdengineId the Id of the Engine
Returnosid.rules.check.AgendaNotificationSession an AgendaNotificationSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT agendaReceiver or engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgendaNotification() and supportsVisibleFederation() are true
MethodgetAgendaEngineSession
Description

Gets the OsidSession to lookup agenda/engine mappings.

Returnosid.rules.check.AgendaEngineSession an AgendaEngineSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaEngine() is false
Complianceoptional This method must be implemented if supportsAgendaEngine() is true.
MethodgetAgendaEngineAssignmentSession
Description

Gets the OsidSession associated with assigning agendas to engines.

Returnosid.rules.check.AgendaEngineAssignmentSession an AgendaEngineAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaEngineAssignment() is false
Complianceoptional This method must be implemented if supportsAgendaEngineAssignment() is true.
MethodgetAgendaSmartEngineSession
Description

Gets the OsidSession to manage agenda smart engines.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.AgendaSmartEngineSession an AgendaSmartEngineSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgendaSmartEngine() is false
Complianceoptional This method must be implemented if supportsAgendaSmartEngine() is true.
MethodgetInstructionApplicabilitySession
Description

Gets the OsidSession associated with the instruction applicability service.

Returnosid.rules.check.InstructionApplicabilitySession an InstructionApplicabilitySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionApplicability() is false
Complianceoptional This method must be implemented if supportsInstructionApplicability() is true.
MethodgetInstructionApplicabilitySessionForEngine
Description

Gets the OsidSession associated with the instruction applicability service for the given engine.

Parametersosid.id.IdengineId the Id of the engine
Returnosid.rules.check.InstructionApplicabilitySession an InstructionApplicabilitySession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionApplicability() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInstructionApplicability() and supportsVisibleFederation() are true
MethodgetInstructionLookupSession
Description

Gets the OsidSession associated with the instruction lookup service.

Returnosid.rules.check.InstructionLookupSession an InstructionLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionLookup() is false
Complianceoptional This method must be implemented if supportsInstructionLookup() is true.
MethodgetInstructionLookupSessionForEngine
Description

Gets the OsidSession associated with the instruction lookup service for the given engine.

Parametersosid.id.IdengineId the Id of the engine
Returnosid.rules.check.InstructionLookupSession an InstructionLookupSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInstructionLookup() and supportsVisibleFederation() are true
MethodgetInstructionQuerySession
Description

Gets the OsidSession associated with the instruction query service.

Returnosid.rules.check.InstructionQuerySession an InstructionQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionQuery() is false
Complianceoptional This method must be implemented if supportsInstructionQuery() is true.
MethodgetInstructionQuerySessionForEngine
Description

Gets the OsidSession associated with the instruction query service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.InstructionQuerySession an InstructionQuerySession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInstructionQuery() and supportsVisibleFederation() are true
MethodgetInstructionSearchSession
Description

Gets the OsidSession associated with the instruction search service.

Returnosid.rules.check.InstructionSearchSession an InstructionSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionSearch() is false
Complianceoptional This method must be implemented if supportsInstructionSearch() is true.
MethodgetInstructionSearchSessionForEngine
Description

Gets the OsidSession associated with the instruction search service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.InstructionSearchSession an InstructionSearchSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInstructionSearch() and supportsVisibleFederation() are true
MethodgetInstructionAdminSession
Description

Gets the OsidSession associated with the instruction administration service.

Returnosid.rules.check.InstructionAdminSession an InstructionAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionAdmin() is false
Complianceoptional This method must be implemented if supportsInstructionAdmin() is true.
MethodgetInstructionAdminSessionForEngine
Description

Gets the OsidSession associated with the instruction administration service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.InstructionAdminSession an InstructionAdminSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInstructionAdmin() and supportsVisibleFederation() are true
MethodgetInstructionNotificationSession
Description

Gets the OsidSession associated with the instruction notification service.

Parametersosid.rules.check.InstructionReceiverinstructionReceiver the notification callback
Returnosid.rules.check.InstructionNotificationSession an InstructionNotificationSession
ErrorsNULL_ARGUMENT instructionReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionNotification() is false
Complianceoptional This method must be implemented if supportsInstructionNotification() is true.
MethodgetInstructionNotificationSessionForEngine
Description

Gets the OsidSession associated with the instruction notification service for the given engine.

Parametersosid.rules.check.InstructionReceiverinstructionReceiver the notification callback
osid.id.IdengineId the Id of the Engine
Returnosid.rules.check.InstructionNotificationSession an InstructionNotificationSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT instructionReceiver or engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInstructionNotification() and supportsVisibleFederation() are true
MethodgetInstructionEngineSession
Description

Gets the OsidSession to lookup instruction/engine checks.

Returnosid.rules.check.InstructionEngineSession an InstructionEngineSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionEngine() is false
Complianceoptional This method must be implemented if supportsInstructionEngine() is true.
MethodgetInstructionEngineAssignmentSession
Description

Gets the OsidSession associated with assigning instructions to engines.

Returnosid.rules.check.InstructionEngineAssignmentSession an InstructionEngineAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionEngineAssignment() is false
Complianceoptional This method must be implemented if supportsInstructionEngineAssignment() is true.
MethodgetInstructionSmartEngineSession
Description

Gets the OsidSession to manage locatin smart engines.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.InstructionSmartEngineSession an InstructionSmartEngineSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInstructionSmartEngine() is false
Complianceoptional This method must be implemented if supportsInstructionSmartEngine() is true.
MethodgetCheckEvaluationSession
Description

Gets the OsidSession associated with the check evaluation service.

Returnosid.rules.check.CheckEvaluationSession a CheckEvaluationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckEvaluation() is false
Complianceoptional This method must be implemented if supportsCheckEvaluation() is true.
MethodgetCheckEvaluationSessionForEngine
Description

Gets the OsidSession associated with the check evaluation service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.CheckEvaluationSession a CheckEvaluationSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckEvaluation() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCheckEvaluation() and supportsVisibleFederation() are true
MethodgetCheckLookupSession
Description

Gets the OsidSession associated with the check lookup service.

Returnosid.rules.check.CheckLookupSession a CheckLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckLookup() is false
Complianceoptional This method must be implemented if supportsCheckLookup() is true.
MethodgetCheckLookupSessionForEngine
Description

Gets the OsidSession associated with the check lookup service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.CheckLookupSession a CheckLookupSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCheckLookup() and supportsVisibleFederation() are true
MethodgetCheckQuerySession
Description

Gets the OsidSession associated with the check query service.

Returnosid.rules.check.CheckQuerySession a CheckQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckQuery() is false
Complianceoptional This method must be implemented if supportsCheckQuery() is true.
MethodgetCheckQuerySessionForEngine
Description

Gets the OsidSession associated with the check query service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.CheckQuerySession a CCheckQuerySession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCheckQuery() and supportsVisibleFederation() are true
MethodgetCheckSearchSession
Description

Gets the OsidSession associated with the check search service.

Returnosid.rules.check.CheckSearchSession a CheckSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckSearch() is false
Complianceoptional This method must be implemented if supportsCheckSearch() is true.
MethodgetCheckSearchSessionForEngine
Description

Gets the OsidSession associated with the check search service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.CheckSearchSession a CheckSearchSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCheckSearch() and supportsVisibleFederation() are true
MethodgetCheckAdminSession
Description

Gets the OsidSession associated with the check administrative service.

Returnosid.rules.check.CheckAdminSession a CheckAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckAdmin() is false
Complianceoptional This method must be implemented if supportsCheckAdmin() is true.
MethodgetCheckAdminSessionForEngine
Description

Gets the OsidSession associated with the check administrative service for the given engine.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.CheckAdminSession a CheckAdminSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCheckAdmin() and supportsVisibleFederation() are true
MethodgetCheckNotificationSession
Description

Gets the OsidSession associated with the check notification service.

Parametersosid.rules.check.CheckReceivercheckReceiver the notification callback
Returnosid.rules.check.CheckNotificationSession a CheckNotificationSession
ErrorsNULL_ARGUMENT checkReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckNotification() is false
Complianceoptional This method must be implemented if supportsCheckNotification() is true.
MethodgetCheckNotificationSessionForEngine
Description

Gets the OsidSession associated with the check notification service for the given engine.

Parametersosid.rules.check.CheckReceivercheckReceiver the notification callback
osid.id.IdengineId the Id of the Engine
Returnosid.rules.check.CheckNotificationSession a CheckNotificationSession
ErrorsNOT_FOUND no engine found by the given Id
NULL_ARGUMENT checkReceiver or engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCheckNotification() and supportsVisibleFederation() are true
MethodgetCheckEngineSession
Description

Gets the OsidSession to lookup check/engine mappings.

Returnosid.rules.check.CheckEngineSession a CheckEngineSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckEngine() is false
Complianceoptional This method must be implemented if supportsCheckEngine() is true.
MethodgetCheckEngineAssignmentSession
Description

Gets the OsidSession associated with assigning competencies to engines.

Returnosid.rules.check.CheckEngineAssignmentSession a CheckEngineAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckEngineAssignment() is false
Complianceoptional This method must be implemented if supportsCheckEngineAssignment() is true.
MethodgetCheckSmartEngineSession
Description

Gets the OsidSession to manage check smart engines.

Parametersosid.id.IdengineId the Id of the Engine
Returnosid.rules.check.CheckSmartEngineSession a CheckSmartEngineSession
ErrorsNOT_FOUND no Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCheckSmartEngine() is false
Complianceoptional This method must be implemented if supportsCheckSmartEngine() is true.