OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.RulesCheckManager
Implementsosid.OsidManager
osid.rules.check.RulesCheckProfile
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:

  • EvaluationSession: a session for evaluating agendas
  • ProcessingSession: a session for processing agendas
  • 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
  • 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
  • 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
MethodgetEvaluationSession
Description

Gets the OsidSession associated with the evaluation service to evaluate an agenda.

Returnosid.rules.check.EvaluationSessionan EvaluationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEvaluation() is false
ComplianceoptionalThis method must be implemented if supportsEvaluation() is true.
MethodgetEvaluationSessionForEngine
Description

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

Parametersosid.id.IdengineIdthe Id of the engine
Returnosid.rules.check.EvaluationSessionan EvaluationSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEvaluation() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEvaluation() and supportsVisibleFederation() are true
MethodgetProcessingSession
Description

Gets the OsidSession associated with the processing service to run checks.

Returnosid.rules.check.ProcessingSessiona ProcessingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessing() is false
ComplianceoptionalThis method must be implemented if supportsProcessing() is true.
MethodgetProcessingSessionForEngine
Description

Gets the OsidSession associated with the processing service for the given engine.

Parametersosid.id.IdengineIdthe Id of the engine
Returnosid.rules.check.ProcessingSessiona ProcessingSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcessing() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcessing() and supportsVisibleFederation() are true
MethodgetAgendaLookupSession
Description

Gets the OsidSession associated with the agenda lookup service.

Returnosid.rules.check.AgendaLookupSessionan AgendaLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaLookup() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.AgendaLookupSessionan AgendaLookupSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgendaLookup() and supportsVisibleFederation() are true
MethodgetAgendaQuerySession
Description

Gets the OsidSession associated with the agenda query service.

Returnosid.rules.check.AgendaQuerySessionan AgendaQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaQuery() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.AgendaQuerySessionan AgendaQuerySession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgendaQuery() and supportsVisibleFederation() are true
MethodgetAgendaSearchSession
Description

Gets the OsidSession associated with the agenda search service.

Returnosid.rules.check.AgendaSearchSessionan AgendaSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaSearch() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.AgendaSearchSessionan AgendaSearchSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgendaSearch() and supportsVisibleFederation() are true
MethodgetAgendaAdminSession
Description

Gets the OsidSession associated with the agenda administration service.

Returnosid.rules.check.AgendaAdminSessionan AgendaAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaAdmin() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.AgendaAdminSessionan AgendaAdminSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgendaAdmin() and supportsVisibleFederation() are true
MethodgetAgendaNotificationSession
Description

Gets the OsidSession associated with the agenda notification service.

Parametersosid.rules.check.AgendaReceiveragendaReceiverthe notification callback
Returnosid.rules.check.AgendaNotificationSessionan AgendaNotificationSession
ErrorsNULL_ARGUMENT agendaReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaNotification() is false
ComplianceoptionalThis 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.AgendaReceiveragendaReceiverthe notification callback
osid.id.IdengineIdthe Id of the Engine
Returnosid.rules.check.AgendaNotificationSessionan AgendaNotificationSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT agendaReceiver or engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgendaNotification() and supportsVisibleFederation() are true
MethodgetAgendaEngineSession
Description

Gets the OsidSession to lookup agenda/engine mappings.

Returnosid.rules.check.AgendaEngineSessionan AgendaEngineSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaEngine() is false
ComplianceoptionalThis method must be implemented if supportsAgendaEngine() is true.
MethodgetAgendaEngineAssignmentSession
Description

Gets the OsidSession associated with assigning agendas to engines.

Returnosid.rules.check.AgendaEngineAssignmentSessionan AgendaEngineAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaEngineAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAgendaEngineAssignment() is true.
MethodgetAgendaSmartEngineSession
Description

Gets the OsidSession to manage agenda smart engines.

Parametersosid.id.IdengineIdthe Id of the Engine
Returnosid.rules.check.AgendaSmartEngineSessionan AgendaSmartEngineSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgendaSmartEngine() is false
ComplianceoptionalThis method must be implemented if supportsAgendaSmartEngine() is true.
MethodgetInstructionLookupSession
Description

Gets the OsidSession associated with the instruction lookup service.

Returnosid.rules.check.InstructionLookupSessionan InstructionLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionLookup() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the engine
Returnosid.rules.check.InstructionLookupSessionan InstructionLookupSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInstructionLookup() and supportsVisibleFederation() are true
MethodgetInstructionQuerySession
Description

Gets the OsidSession associated with the instruction query service.

Returnosid.rules.check.InstructionQuerySessionan InstructionQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionQuery() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.InstructionQuerySessionan InstructionQuerySession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInstructionQuery() and supportsVisibleFederation() are true
MethodgetInstructionSearchSession
Description

Gets the OsidSession associated with the instruction search service.

Returnosid.rules.check.InstructionSearchSessionan InstructionSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionSearch() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.InstructionSearchSessionan InstructionSearchSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInstructionSearch() and supportsVisibleFederation() are true
MethodgetInstructionAdminSession
Description

Gets the OsidSession associated with the instruction administration service.

Returnosid.rules.check.InstructionAdminSessionan InstructionAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionAdmin() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.InstructionAdminSessionan InstructionAdminSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInstructionAdmin() and supportsVisibleFederation() are true
MethodgetInstructionNotificationSession
Description

Gets the OsidSession associated with the instruction notification service.

Parametersosid.rules.check.InstructionReceiverinstructionReceiverthe notification callback
Returnosid.rules.check.InstructionNotificationSessionan InstructionNotificationSession
ErrorsNULL_ARGUMENT instructionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionNotification() is false
ComplianceoptionalThis 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.InstructionReceiverinstructionReceiverthe notification callback
osid.id.IdengineIdthe Id of the Engine
Returnosid.rules.check.InstructionNotificationSessionan InstructionNotificationSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT instructionReceiver or engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInstructionNotification() and supportsVisibleFederation() are true
MethodgetInstructionEngineSession
Description

Gets the OsidSession to lookup instruction/engine checks.

Returnosid.rules.check.InstructionEngineSessionan InstructionEngineSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionEngine() is false
ComplianceoptionalThis method must be implemented if supportsInstructionEngine() is true.
MethodgetInstructionEngineAssignmentSession
Description

Gets the OsidSession associated with assigning instructions to engines.

Returnosid.rules.check.InstructionEngineAssignmentSessionan InstructionEngineAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionEngineAssignment() is false
ComplianceoptionalThis method must be implemented if supportsInstructionEngineAssignment() is true.
MethodgetInstructionSmartEngineSession
Description

Gets the OsidSession to manage locatin smart engines.

Parametersosid.id.IdengineIdthe Id of the Engine
Returnosid.rules.check.InstructionSmartEngineSessionan InstructionSmartEngineSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInstructionSmartEngine() is false
ComplianceoptionalThis method must be implemented if supportsInstructionSmartEngine() is true.
MethodgetCheckLookupSession
Description

Gets the OsidSession associated with the check lookup service.

Returnosid.rules.check.CheckLookupSessiona CheckLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckLookup() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.CheckLookupSessiona CheckLookupSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCheckLookup() and supportsVisibleFederation() are true
MethodgetCheckQuerySession
Description

Gets the OsidSession associated with the check query service.

Returnosid.rules.check.CheckQuerySessiona CheckQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckQuery() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.CheckQuerySessiona CCheckQuerySession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCheckQuery() and supportsVisibleFederation() are true
MethodgetCheckSearchSession
Description

Gets the OsidSession associated with the check search service.

Returnosid.rules.check.CheckSearchSessiona CheckSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckSearch() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.CheckSearchSessiona CheckSearchSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCheckSearch() and supportsVisibleFederation() are true
MethodgetCheckAdminSession
Description

Gets the OsidSession associated with the check administrative service.

Returnosid.rules.check.CheckAdminSessiona CheckAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckAdmin() is false
ComplianceoptionalThis 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.IdengineIdthe Id of the Engine
Returnosid.rules.check.CheckAdminSessiona CheckAdminSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCheckAdmin() and supportsVisibleFederation() are true
MethodgetCheckNotificationSession
Description

Gets the OsidSession associated with the check notification service.

Parametersosid.rules.check.CheckReceivercheckReceiverthe notification callback
Returnosid.rules.check.CheckNotificationSessiona CheckNotificationSession
ErrorsNULL_ARGUMENT checkReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckNotification() is false
ComplianceoptionalThis 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.CheckReceivercheckReceiverthe notification callback
osid.id.IdengineIdthe Id of the Engine
Returnosid.rules.check.CheckNotificationSessiona CheckNotificationSession
ErrorsNOT_FOUNDno engine found by the given Id
NULL_ARGUMENT checkReceiver or engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCheckNotification() and supportsVisibleFederation() are true
MethodgetCheckEngineSession
Description

Gets the OsidSession to lookup check/engine mappings.

Returnosid.rules.check.CheckEngineSessiona CheckEngineSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckEngine() is false
ComplianceoptionalThis method must be implemented if supportsCheckEngine() is true.
MethodgetCheckEngineAssignmentSession
Description

Gets the OsidSession associated with assigning competencies to engines.

Returnosid.rules.check.CheckEngineAssignmentSessiona CheckEngineAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckEngineAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCheckEngineAssignment() is true.
MethodgetCheckSmartEngineSession
Description

Gets the OsidSession to manage check smart engines.

Parametersosid.id.IdengineIdthe Id of the Engine
Returnosid.rules.check.CheckSmartEngineSessiona CheckSmartEngineSession
ErrorsNOT_FOUNDno Engine found by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCheckSmartEngine() is false
ComplianceoptionalThis method must be implemented if supportsCheckSmartEngine() is true.