org.osid.rules.check

Interface RulesCheckProxyManager

All Superinterfaces:

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

public interface RulesCheckProxyManager
extends OsidProxyManager, RulesCheckProfile

The check proxy manager provides access to rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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 check
• CheckQuerySession: a session to query for check
• CheckSearchSession: a session to search for check
• 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(Proxy proxy) Gets the OsidSession associated with the agenda administration service.
AgendaAdminSession	getAgendaAdminSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the agenda administration service for the given engine.
AgendaEngineAssignmentSession	getAgendaEngineAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning agendas to engines.
AgendaEngineSession	getAgendaEngineSession(Proxy proxy) Gets the OsidSession to lookup agenda/engine mappings.
AgendaLookupSession	getAgendaLookupSession(Proxy proxy) Gets the OsidSession associated with the agenda lookup service.
AgendaLookupSession	getAgendaLookupSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the agenda lookup service for the given engine.
AgendaNotificationSession	getAgendaNotificationSession(AgendaReceiver agendaReceiver, Proxy proxy) Gets the OsidSession associated with the agenda notification service.
AgendaNotificationSession	getAgendaNotificationSessionForEngine(AgendaReceiver agendaReceiver, Id engineId, Proxy proxy) Gets the OsidSession associated with the agenda notification service for the given engine.
AgendaQuerySession	getAgendaQuerySession(Proxy proxy) Gets the OsidSession associated with the agenda query service.
AgendaQuerySession	getAgendaQuerySessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the agenda query service for the given engine.
AgendaSearchSession	getAgendaSearchSession(Proxy proxy) Gets the OsidSession associated with the agenda search service.
AgendaSearchSession	getAgendaSearchSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the agenda search service for the given engine.
AgendaSmartEngineSession	getAgendaSmartEngineSession(Id engineId, Proxy proxy) Gets the OsidSession to manage agenda smart engines.
CheckAdminSession	getCheckAdminSession(Proxy proxy) Gets the OsidSession associated with the check administrative service.
CheckAdminSession	getCheckAdminSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the check administrative service for the given engine.
CheckEngineAssignmentSession	getCheckEngineAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning competencies to engines.
CheckEngineSession	getCheckEngineSession(Proxy proxy) Gets the OsidSession to lookup check/engine mappings.
CheckLookupSession	getCheckLookupSession(Proxy proxy) Gets the OsidSession associated with the check lookup service.
CheckLookupSession	getCheckLookupSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the check lookup service for the given engine.
CheckNotificationSession	getCheckNotificationSession(CheckReceiver checkReceiver, Proxy proxy) Gets the OsidSession associated with the check notification service.
CheckNotificationSession	getCheckNotificationSessionForEngine(CheckReceiver checkReceiver, Id engineId, Proxy proxy) Gets the OsidSession associated with the check notification service for the given engine.
CheckQuerySession	getCheckQuerySession(Proxy proxy) Gets the OsidSession associated with the check query service.
CheckQuerySession	getCheckQuerySessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the check query service for the given engine.
CheckSearchSession	getCheckSearchSession(Proxy proxy) Gets the OsidSession associated with the check search service.
CheckSearchSession	getCheckSearchSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the check search service for the given engine.
CheckSmartEngineSession	getCheckSmartEngineSession(Id engineId, Proxy proxy) Gets the OsidSession to manage check smart engines.
EvaluationSession	getEvaluationSession(Proxy proxy) Gets the OsidSession associated with the evaluation service to evaluate an agenda.
EvaluationSession	getEvaluationSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the evaluation service for the given engine.
InstructionAdminSession	getInstructionAdminSession(Proxy proxy) Gets the OsidSession associated with the instruction administration service.
InstructionAdminSession	getInstructionAdminSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the instruction administration service for the given engine.
InstructionEngineAssignmentSession	getInstructionEngineAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning mappings to engines.
InstructionEngineSession	getInstructionEngineSession(Proxy proxy) Gets the OsidSession to lookup instruction/engine checks.
InstructionLookupSession	getInstructionLookupSession(Proxy proxy) Gets the OsidSession associated with the instruction lookup service.
InstructionLookupSession	getInstructionLookupSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the instruction lookup service for the given engine.
InstructionNotificationSession	getInstructionNotificationSession(InstructionReceiver instructionReceiver, Proxy proxy) Gets the OsidSession associated with the instruction notification service.
InstructionNotificationSession	getInstructionNotificationSessionForEngine(InstructionReceiver instructionReceiver, Id engineId, Proxy proxy) Gets the OsidSession associated with the instruction notification service for the given engine.
InstructionQuerySession	getInstructionQuerySession(Proxy proxy) Gets the OsidSession associated with the instruction query service.
InstructionQuerySession	getInstructionQuerySessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the instruction query service for the given engine.
InstructionSearchSession	getInstructionSearchSession(Proxy proxy) Gets the OsidSession associated with the instruction search service.
InstructionSearchSession	getInstructionSearchSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the instruction search service for the given engine.
InstructionSmartEngineSession	getInstructionSmartEngineSession(Id engineId, Proxy proxy) Gets the OsidSession to manage locatin smart engines.
ProcessingSession	getProcessingSession(Proxy proxy) Gets the OsidSession associated with the processing service to run checks.
ProcessingSession	getProcessingSessionForEngine(Id engineId, Proxy proxy) Gets the OsidSession associated with the processing service for the given engine.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                       throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an EvaluationSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the engine

proxy - a proxy

Returns:

an EvaluationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a ProcessingSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the engine

proxy - a proxy

Returns:

a ProcessingSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the agenda lookup service.

Parameters:

proxy - a proxy

Returns:

an AgendaLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an AgendaLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the agenda query service.

Parameters:

proxy - a proxy

Returns:

an AgendaQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an AgendaQuerySession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the agenda search service.

Parameters:

proxy - a proxy

Returns:

an AgendaSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an AgendaSearchSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the agenda administration service.

Parameters:

proxy - a proxy

Returns:

an AgendaAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an AgendaAdminSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the agenda notification service.

Parameters:

agendaReceiver - the notification callback

proxy - a proxy

Returns:

an AgendaNotificationSession

Throws:

NullArgumentException - agendaReceiver or proxy 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,
                                                              Proxy proxy)
                                                                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

proxy - a proxy

Returns:

an AgendaNotificationSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - agendaReceiver, engineId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession to lookup agenda/engine mappings.

Parameters:

proxy - a proxy

Returns:

an AgendaEngineSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaEngine() is false

Compliance:

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

getAgendaEngineAssignmentSession

AgendaEngineAssignmentSession getAgendaEngineAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning agendas to engines.

Parameters:

proxy - a proxy

Returns:

an AgendaEngineAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession to manage agenda smart engines.

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an AgendaSmartEngineSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the instruction lookup service.

Parameters:

proxy - a proxy

Returns:

an InstructionLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

engineId - the Id of the engine

proxy - a proxy

Returns:

an InstructionLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the instruction query service.

Parameters:

proxy - a proxy

Returns:

an InstructionQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an InstructionQuerySession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the instruction search service.

Parameters:

proxy - a proxy

Returns:

an InstructionSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an InstructionSearchSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the instruction administration service.

Parameters:

proxy - a proxy

Returns:

an InstructionAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an InstructionAdminSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the instruction notification service.

Parameters:

instructionReceiver - the notification callback

proxy - a proxy

Returns:

an InstructionNotificationSession

Throws:

NullArgumentException - instructionReceiver or proxy 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,
                                                                        Proxy proxy)
                                                                          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

proxy - a proxy

Returns:

an InstructionNotificationSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - instructionReceiver, engineId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession to lookup instruction/engine checks.

Parameters:

proxy - a proxy

Returns:

an InstructionEngineSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionEngine() is false

Compliance:

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

getInstructionEngineAssignmentSession

InstructionEngineAssignmentSession getInstructionEngineAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning mappings to engines.

Parameters:

proxy - a proxy

Returns:

an InstructionEngineAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage locatin smart engines.

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

an InstructionSmartEngineSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the check lookup service.

Parameters:

proxy - a proxy

Returns:

a CheckLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

a CheckLookupSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the check query service.

Parameters:

proxy - a proxy

Returns:

a CheckQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

a CheckQuerySession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the check search service.

Parameters:

proxy - a proxy

Returns:

a CheckSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

a CheckSearchSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the check administrative service.

Parameters:

proxy - a proxy

Returns:

a CheckAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

a CheckAdminSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the check notification service.

Parameters:

checkReceiver - the notification callback

proxy - a proxy

Returns:

a CheckNotificationSession

Throws:

NullArgumentException - checkReceiver or proxy 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,
                                                            Proxy proxy)
                                                              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

proxy - a proxy

Returns:

a CheckNotificationSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - checkReceiver, engineId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession to lookup check/engine mappings.

Parameters:

proxy - a proxy

Returns:

a CheckEngineSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckEngine() is false

Compliance:

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

getCheckEngineAssignmentSession

CheckEngineAssignmentSession getCheckEngineAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with assigning competencies to engines.

Parameters:

proxy - a proxy

Returns:

a CheckEngineAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession to manage check smart engines.

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

a CheckSmartEngineSession

Throws:

NotFoundException - no engine found by the given Id

NullArgumentException - engineId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckSmartEngine() is false

Compliance:

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