org.osid.rules.check

Interface RulesCheckManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RulesCheckProfile, Sourceable

public interface RulesCheckManager
extends OsidManager, RulesCheckProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AgendaAdminSession	getAgendaAdminSession() Gets the OsidSession associated with the agenda administration service.
AgendaAdminSession	getAgendaAdminSessionForEngine(Id engineId) Gets the OsidSession associated with the agenda administration service for the given engine.
AgendaEngineAssignmentSession	getAgendaEngineAssignmentSession() Gets the OsidSession associated with assigning agendas to engines.
AgendaEngineSession	getAgendaEngineSession() Gets the OsidSession to lookup agenda/engine mappings.
AgendaLookupSession	getAgendaLookupSession() Gets the OsidSession associated with the agenda lookup service.
AgendaLookupSession	getAgendaLookupSessionForEngine(Id engineId) Gets the OsidSession associated with the agenda lookup service for the given engine.
AgendaNotificationSession	getAgendaNotificationSession(AgendaReceiver agendaReceiver) Gets the OsidSession associated with the agenda notification service.
AgendaNotificationSession	getAgendaNotificationSessionForEngine(AgendaReceiver agendaReceiver, Id engineId) Gets the OsidSession associated with the agenda notification service for the given engine.
AgendaQuerySession	getAgendaQuerySession() Gets the OsidSession associated with the agenda query service.
AgendaQuerySession	getAgendaQuerySessionForEngine(Id engineId) Gets the OsidSession associated with the agenda query service for the given engine.
AgendaSearchSession	getAgendaSearchSession() Gets the OsidSession associated with the agenda search service.
AgendaSearchSession	getAgendaSearchSessionForEngine(Id engineId) Gets the OsidSession associated with the agenda search service for the given engine.
AgendaSmartEngineSession	getAgendaSmartEngineSession(Id engineId) Gets the OsidSession to manage agenda smart engines.
CheckAdminSession	getCheckAdminSession() Gets the OsidSession associated with the check administrative service.
CheckAdminSession	getCheckAdminSessionForEngine(Id engineId) Gets the OsidSession associated with the check administrative service for the given engine.
CheckEngineAssignmentSession	getCheckEngineAssignmentSession() Gets the OsidSession associated with assigning competencies to engines.
CheckEngineSession	getCheckEngineSession() Gets the OsidSession to lookup check/engine mappings.
CheckLookupSession	getCheckLookupSession() Gets the OsidSession associated with the check lookup service.
CheckLookupSession	getCheckLookupSessionForEngine(Id engineId) Gets the OsidSession associated with the check lookup service for the given engine.
CheckNotificationSession	getCheckNotificationSession(CheckReceiver checkReceiver) Gets the OsidSession associated with the check notification service.
CheckNotificationSession	getCheckNotificationSessionForEngine(CheckReceiver checkReceiver, Id engineId) Gets the OsidSession associated with the check notification service for the given engine.
CheckQuerySession	getCheckQuerySession() Gets the OsidSession associated with the check query service.
CheckQuerySession	getCheckQuerySessionForEngine(Id engineId) Gets the OsidSession associated with the check query service for the given engine.
CheckSearchSession	getCheckSearchSession() Gets the OsidSession associated with the check search service.
CheckSearchSession	getCheckSearchSessionForEngine(Id engineId) Gets the OsidSession associated with the check search service for the given engine.
CheckSmartEngineSession	getCheckSmartEngineSession(Id engineId) Gets the OsidSession to manage check smart engines.
EvaluationSession	getEvaluationSession() Gets the OsidSession associated with the evaluation service to evaluate an agenda.
EvaluationSession	getEvaluationSessionForEngine(Id engineId) Gets the OsidSession associated with the evaluation service for the given engine.
InstructionAdminSession	getInstructionAdminSession() Gets the OsidSession associated with the instruction administration service.
InstructionAdminSession	getInstructionAdminSessionForEngine(Id engineId) Gets the OsidSession associated with the instruction administration service for the given engine.
InstructionEngineAssignmentSession	getInstructionEngineAssignmentSession() Gets the OsidSession associated with assigning instructions to engines.
InstructionEngineSession	getInstructionEngineSession() Gets the OsidSession to lookup instruction/engine checks.
InstructionLookupSession	getInstructionLookupSession() Gets the OsidSession associated with the instruction lookup service.
InstructionLookupSession	getInstructionLookupSessionForEngine(Id engineId) Gets the OsidSession associated with the instruction lookup service for the given engine.
InstructionNotificationSession	getInstructionNotificationSession(InstructionReceiver instructionReceiver) Gets the OsidSession associated with the instruction notification service.
InstructionNotificationSession	getInstructionNotificationSessionForEngine(InstructionReceiver instructionReceiver, Id engineId) Gets the OsidSession associated with the instruction notification service for the given engine.
InstructionQuerySession	getInstructionQuerySession() Gets the OsidSession associated with the instruction query service.
InstructionQuerySession	getInstructionQuerySessionForEngine(Id engineId) Gets the OsidSession associated with the instruction query service for the given engine.
InstructionSearchSession	getInstructionSearchSession() Gets the OsidSession associated with the instruction search service.
InstructionSearchSession	getInstructionSearchSessionForEngine(Id engineId) Gets the OsidSession associated with the instruction search service for the given engine.
InstructionSmartEngineSession	getInstructionSmartEngineSession(Id engineId) Gets the OsidSession to manage locatin smart engines.
ProcessingSession	getProcessingSession() Gets the OsidSession associated with the processing service to run checks.
ProcessingSession	getProcessingSessionForEngine(Id engineId) Gets the OsidSession associated with the processing service for the given engine.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.rules.check.RulesCheckProfile

getAgendaRecordTypes, getAgendaSearchRecordTypes, getCheckRecordTypes, getCheckResultRecordTypes, getCheckSearchRecordTypes, getInstructionRecordTypes, getInstructionSearchRecordTypes, supportsAgendaAdmin, supportsAgendaEngine, supportsAgendaEngineAssignment, supportsAgendaLookup, supportsAgendaNotification, supportsAgendaQuery, supportsAgendaRecordType, supportsAgendaSearch, supportsAgendaSearchRecordType, supportsAgendaSmartEngine, supportsCheckAdmin, supportsCheckEngine, supportsCheckEngineAssignment, supportsCheckLookup, supportsCheckNotification, supportsCheckQuery, supportsCheckRecordType, supportsCheckResultRecordType, supportsCheckSearch, supportsCheckSearchRecordType, supportsCheckSmartEngine, supportsEvaluation, supportsInstructionAdmin, supportsInstructionEngine, supportsInstructionEngineAssignment, supportsInstructionLookup, supportsInstructionNotification, supportsInstructionQuery, supportsInstructionRecordType, supportsInstructionSearch, supportsInstructionSearchRecordType, supportsInstructionSmartEngine, supportsProcessing, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getEvaluationSession

EvaluationSession getEvaluationSession()
                                       throws OperationFailedException

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

Returns:

an EvaluationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEvaluation() is false

Compliance:

optional - This method must be implemented if supportsEvaluation() is true.

getEvaluationSessionForEngine

EvaluationSession getEvaluationSessionForEngine(Id engineId)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the engine

Returns:

an EvaluationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEvaluation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEvaluation() and supportsVisibleFederation() are true

getProcessingSession

ProcessingSession getProcessingSession()
                                       throws OperationFailedException

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

Returns:

a ProcessingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessing() is false

Compliance:

optional - This method must be implemented if supportsProcessing() is true.

getProcessingSessionForEngine

ProcessingSession getProcessingSessionForEngine(Id engineId)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the engine

Returns:

a ProcessingSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessing() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcessing() and supportsVisibleFederation() are true

getAgendaLookupSession

AgendaLookupSession getAgendaLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the agenda lookup service.

Returns:

an AgendaLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaLookup() is false

Compliance:

optional - This method must be implemented if supportsAgendaLookup() is true.

getAgendaLookupSessionForEngine

AgendaLookupSession getAgendaLookupSessionForEngine(Id engineId)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

an AgendaLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgendaLookup() and supportsVisibleFederation() are true

getAgendaQuerySession

AgendaQuerySession getAgendaQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the agenda query service.

Returns:

an AgendaQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaQuery() is false

Compliance:

optional - This method must be implemented if supportsAgendaQuery() is true.

getAgendaQuerySessionForEngine

AgendaQuerySession getAgendaQuerySessionForEngine(Id engineId)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

an AgendaQuerySession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgendaQuery() and supportsVisibleFederation() are true

getAgendaSearchSession

AgendaSearchSession getAgendaSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the agenda search service.

Returns:

an AgendaSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaSearch() is false

Compliance:

optional - This method must be implemented if supportsAgendaSearch() is true.

getAgendaSearchSessionForEngine

AgendaSearchSession getAgendaSearchSessionForEngine(Id engineId)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

an AgendaSearchSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgendaSearch() and supportsVisibleFederation() are true

getAgendaAdminSession

AgendaAdminSession getAgendaAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the agenda administration service.

Returns:

an AgendaAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaAdmin() is false

Compliance:

optional - This method must be implemented if supportsAgendaAdmin() is true.

getAgendaAdminSessionForEngine

AgendaAdminSession getAgendaAdminSessionForEngine(Id engineId)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

an AgendaAdminSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgendaAdmin() and supportsVisibleFederation() are true

getAgendaNotificationSession

AgendaNotificationSession getAgendaNotificationSession(AgendaReceiver agendaReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the agenda notification service.

Parameters:

agendaReceiver - the notification callback

Returns:

an AgendaNotificationSession

Throws:

NullArgumentException - agendaReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaNotification() is false

Compliance:

optional - This method must be implemented if supportsAgendaNotification() is true.

getAgendaNotificationSessionForEngine

AgendaNotificationSession getAgendaNotificationSessionForEngine(AgendaReceiver agendaReceiver,
                                                              Id engineId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

agendaReceiver - the notification callback

engineId - the Id of the Engine

Returns:

an AgendaNotificationSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - agendaReceiver or engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgendaNotification() and supportsVisibleFederation() are true

getAgendaEngineSession

AgendaEngineSession getAgendaEngineSession()
                                           throws OperationFailedException

Gets the OsidSession to lookup agenda/engine mappings.

Returns:

an AgendaEngineSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaEngine() is false

Compliance:

optional - This method must be implemented if supportsAgendaEngine() is true.

getAgendaEngineAssignmentSession

AgendaEngineAssignmentSession getAgendaEngineAssignmentSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning agendas to engines.

Returns:

an AgendaEngineAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaEngineAssignment() is false

Compliance:

optional - This method must be implemented if supportsAgendaEngineAssignment() is true.

getAgendaSmartEngineSession

AgendaSmartEngineSession getAgendaSmartEngineSession(Id engineId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession to manage agenda smart engines.

Parameters:

engineId - the Id of the Engine

Returns:

an AgendaSmartEngineSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaSmartEngine() is false

Compliance:

optional - This method must be implemented if supportsAgendaSmartEngine() is true.

getInstructionLookupSession

InstructionLookupSession getInstructionLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the instruction lookup service.

Returns:

an InstructionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionLookup() is false

Compliance:

optional - This method must be implemented if supportsInstructionLookup() is true.

getInstructionLookupSessionForEngine

InstructionLookupSession getInstructionLookupSessionForEngine(Id engineId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

engineId - the Id of the engine

Returns:

an InstructionLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInstructionLookup() and supportsVisibleFederation() are true

getInstructionQuerySession

InstructionQuerySession getInstructionQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the instruction query service.

Returns:

an InstructionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionQuery() is false

Compliance:

optional - This method must be implemented if supportsInstructionQuery() is true.

getInstructionQuerySessionForEngine

InstructionQuerySession getInstructionQuerySessionForEngine(Id engineId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

an InstructionQuerySession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInstructionQuery() and supportsVisibleFederation() are true

getInstructionSearchSession

InstructionSearchSession getInstructionSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the instruction search service.

Returns:

an InstructionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionSearch() is false

Compliance:

optional - This method must be implemented if supportsInstructionSearch() is true.

getInstructionSearchSessionForEngine

InstructionSearchSession getInstructionSearchSessionForEngine(Id engineId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

an InstructionSearchSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInstructionSearch() and supportsVisibleFederation() are true

getInstructionAdminSession

InstructionAdminSession getInstructionAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the instruction administration service.

Returns:

an InstructionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionAdmin() is false

Compliance:

optional - This method must be implemented if supportsInstructionAdmin() is true.

getInstructionAdminSessionForEngine

InstructionAdminSession getInstructionAdminSessionForEngine(Id engineId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

an InstructionAdminSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInstructionAdmin() and supportsVisibleFederation() are true

getInstructionNotificationSession

InstructionNotificationSession getInstructionNotificationSession(InstructionReceiver instructionReceiver)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the instruction notification service.

Parameters:

instructionReceiver - the notification callback

Returns:

an InstructionNotificationSession

Throws:

NullArgumentException - instructionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionNotification() is false

Compliance:

optional - This method must be implemented if supportsInstructionNotification() is true.

getInstructionNotificationSessionForEngine

InstructionNotificationSession getInstructionNotificationSessionForEngine(InstructionReceiver instructionReceiver,
                                                                        Id engineId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

instructionReceiver - the notification callback

engineId - the Id of the Engine

Returns:

an InstructionNotificationSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - instructionReceiver or engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInstructionNotification() and supportsVisibleFederation() are true

getInstructionEngineSession

InstructionEngineSession getInstructionEngineSession()
                                                     throws OperationFailedException

Gets the OsidSession to lookup instruction/engine checks.

Returns:

an InstructionEngineSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionEngine() is false

Compliance:

optional - This method must be implemented if supportsInstructionEngine() is true.

getInstructionEngineAssignmentSession

InstructionEngineAssignmentSession getInstructionEngineAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning instructions to engines.

Returns:

an InstructionEngineAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionEngineAssignment() is false

Compliance:

optional - This method must be implemented if supportsInstructionEngineAssignment() is true.

getInstructionSmartEngineSession

InstructionSmartEngineSession getInstructionSmartEngineSession(Id engineId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage locatin smart engines.

Parameters:

engineId - the Id of the Engine

Returns:

an InstructionSmartEngineSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionSmartEngine() is false

Compliance:

optional - This method must be implemented if supportsInstructionSmartEngine() is true.

getCheckLookupSession

CheckLookupSession getCheckLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the check lookup service.

Returns:

a CheckLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckLookup() is false

Compliance:

optional - This method must be implemented if supportsCheckLookup() is true.

getCheckLookupSessionForEngine

CheckLookupSession getCheckLookupSessionForEngine(Id engineId)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

a CheckLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCheckLookup() and supportsVisibleFederation() are true

getCheckQuerySession

CheckQuerySession getCheckQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the check query service.

Returns:

a CheckQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckQuery() is false

Compliance:

optional - This method must be implemented if supportsCheckQuery() is true.

getCheckQuerySessionForEngine

CheckQuerySession getCheckQuerySessionForEngine(Id engineId)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

a CCheckQuerySession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCheckQuery() and supportsVisibleFederation() are true

getCheckSearchSession

CheckSearchSession getCheckSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the check search service.

Returns:

a CheckSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckSearch() is false

Compliance:

optional - This method must be implemented if supportsCheckSearch() is true.

getCheckSearchSessionForEngine

CheckSearchSession getCheckSearchSessionForEngine(Id engineId)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

a CheckSearchSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCheckSearch() and supportsVisibleFederation() are true

getCheckAdminSession

CheckAdminSession getCheckAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the check administrative service.

Returns:

a CheckAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckAdmin() is false

Compliance:

optional - This method must be implemented if supportsCheckAdmin() is true.

getCheckAdminSessionForEngine

CheckAdminSession getCheckAdminSessionForEngine(Id engineId)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

a CheckAdminSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCheckAdmin() and supportsVisibleFederation() are true

getCheckNotificationSession

CheckNotificationSession getCheckNotificationSession(CheckReceiver checkReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the check notification service.

Parameters:

checkReceiver - the notification callback

Returns:

a CheckNotificationSession

Throws:

NullArgumentException - checkReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckNotification() is false

Compliance:

optional - This method must be implemented if supportsCheckNotification() is true.

getCheckNotificationSessionForEngine

CheckNotificationSession getCheckNotificationSessionForEngine(CheckReceiver checkReceiver,
                                                            Id engineId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

checkReceiver - the notification callback

engineId - the Id of the Engine

Returns:

a CheckNotificationSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - checkReceiver or engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCheckNotification() and supportsVisibleFederation() are true

getCheckEngineSession

CheckEngineSession getCheckEngineSession()
                                         throws OperationFailedException

Gets the OsidSession to lookup check/engine mappings.

Returns:

a CheckEngineSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckEngine() is false

Compliance:

optional - This method must be implemented if supportsCheckEngine() is true.

getCheckEngineAssignmentSession

CheckEngineAssignmentSession getCheckEngineAssignmentSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with assigning competencies to engines.

Returns:

a CheckEngineAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckEngineAssignment() is false

Compliance:

optional - This method must be implemented if supportsCheckEngineAssignment() is true.

getCheckSmartEngineSession

CheckSmartEngineSession getCheckSmartEngineSession(Id engineId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession to manage check smart engines.

Parameters:

engineId - the Id of the Engine

Returns:

a CheckSmartEngineSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckSmartEngine() is false

Compliance:

optional - This method must be implemented if supportsCheckSmartEngine() is true.