Interface RulesCheckManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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:

• AgendaSession : a session for evaluating agendas
• AgendaEvaluationSession : a session for evaluating agendas with detailed results
• AgendaLookupSession : a session to retrieve agendas
• AgendaQuerySession : a session to query for agendas
• AgendaSearchSession : a session to search for agendas
• AgendaAdminSession : a session to create and delete agendas
• AgendaNotificationSession : a session to receive notifications pertaining to agenda changes
• AgendaEngineSession : a session to looking mappings of agendas to engines
• AgendaEngineAssignmentSession : a session to manage agenda to engine mappings
• AgendaEngineAssignmentSession : a session to manage dynamic engines of agendas

• InstructionApplicabilitySession : a session to evaluate the applicability of instructions
• InstructionLookupSession : a session to retrieve instructions
• InstructionQuerySession : a session to query for instructions
• InstructionSearchSession : a session to search for instructions
• InstructionAdminSession : a session to create and delete instructions
• InstructionNotificationSession : a session to receive notifications pertaining to instruction changes
• InstructionEngineSession : a session to look up instruction engine mappings
• InstructionEngineAssignmentSession : a session to manage instruction to engine mappings
• InstructionSmartEngineSession : a session to manage dynamic engines of instructions

• CheckEvaluationSession : a session to evaluate checks
• CheckLookupSession : a session to retrieve checks
• CheckQuerySession : a session to query for checks
• CheckSearchSession : a session to search for checks
• CheckAdminSession : a session to create and delete checks
• CheckNotificationSession : a session to receive notifications pertaining to check changes
• CheckEngineSession : a session to look up check engine mappings
• CheckEngineAssignmentSession : a session to manage check to engine mappings
• CheckSmartEngineSession : a session to manage dynamic engines of checks

Method Summary

Modifier and Type	Method	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.
AgendaEvaluationSession	getAgendaEvaluationSession()	Gets the OsidSession associated with the agenda evaluation service.
AgendaEvaluationSession	getAgendaEvaluationSessionForEngine(Id engineId)	Gets the OsidSession associated with the agenda evaluation service for the given engine.
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.
AgendaSession	getAgendaSession()	Gets the OsidSession associated with the agenda evaluation service.
AgendaSession	getAgendaSessionForEngine(Id engineId)	Gets the OsidSession associated with the agenda evaluation 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.
CheckEvaluationSession	getCheckEvaluationSession()	Gets the OsidSession associated with the check evaluation service.
CheckEvaluationSession	getCheckEvaluationSessionForEngine(Id engineId)	Gets the OsidSession associated with the check evaluation service for the given engine.
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.
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.
InstructionApplicabilitySession	getInstructionApplicabilitySession()	Gets the OsidSession associated with the instruction applicability service.
InstructionApplicabilitySession	getInstructionApplicabilitySessionForEngine(Id engineId)	Gets the OsidSession associated with the instruction applicability 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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface RulesCheckProfile

getAgendaConditionRecordTypes, getAgendaRecordTypes, getAgendaSearchRecordTypes, getCheckConditionRecordTypes, getCheckRecordTypes, getCheckResultRecordTypes, getCheckSearchRecordTypes, getInstructionConditionRecordTypes, getInstructionRecordTypes, getInstructionSearchRecordTypes, supportsAgenda, supportsAgendaAdmin, supportsAgendaConditionRecordType, supportsAgendaEngine, supportsAgendaEngineAssignment, supportsAgendaEvaluation, supportsAgendaLookup, supportsAgendaNotification, supportsAgendaQuery, supportsAgendaRecordType, supportsAgendaSearch, supportsAgendaSearchRecordType, supportsAgendaSmartEngine, supportsCheckAdmin, supportsCheckConditionRecordType, supportsCheckEngine, supportsCheckEngineAssignment, supportsCheckEvaluation, supportsCheckLookup, supportsCheckNotification, supportsCheckQuery, supportsCheckRecordType, supportsCheckResultRecordType, supportsCheckSearch, supportsCheckSearchRecordType, supportsCheckSmartEngine, supportsInstructionAdmin, supportsInstructionApplicability, supportsInstructionConditionRecordType, supportsInstructionEngine, supportsInstructionEngineAssignment, supportsInstructionLookup, supportsInstructionNotification, supportsInstructionQuery, supportsInstructionRecordType, supportsInstructionSearch, supportsInstructionSearchRecordType, supportsInstructionSmartEngine, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAgendaConditionRecordTypes()	Gets the supported AgendaCondition record types.
TypeList	getAgendaRecordTypes()	Gets the supported Agenda record types.
TypeList	getAgendaSearchRecordTypes()	Gets the supported Agenda search record types.
TypeList	getCheckConditionRecordTypes()	Gets the supported CheckCondition record types.
TypeList	getCheckRecordTypes()	Gets the supported Check record types.
TypeList	getCheckResultRecordTypes()	Gets the supported CheckResult record types.
TypeList	getCheckSearchRecordTypes()	Gets the supported Check search record types.
TypeList	getInstructionConditionRecordTypes()	Gets the supported InstructionCondition record types.
TypeList	getInstructionRecordTypes()	Gets the supported Instruction record types.
TypeList	getInstructionSearchRecordTypes()	Gets the supported Instruction search types.
boolean	supportsAgenda()	Tests if an agenda evaluation service is supported.
boolean	supportsAgendaAdmin()	Tests if agenda administrative service is supported.
boolean	supportsAgendaConditionRecordType(Type agendaConditionRecordType)	Tests if the given AgendaCondition record type is supported.
boolean	supportsAgendaEngine()	Tests if an agenda engine lookup service is supported.
boolean	supportsAgendaEngineAssignment()	Tests if an agenda engine service is supported.
boolean	supportsAgendaEvaluation()	Tests if an agenda evaluation service with detailed results is supported.
boolean	supportsAgendaLookup()	Tests if looking up agendas is supported.
boolean	supportsAgendaNotification()	Tests if an agenda notification service is supported.
boolean	supportsAgendaQuery()	Tests if querying agendas is supported.
boolean	supportsAgendaRecordType(Type agendaRecordType)	Tests if the given Agenda record type is supported.
boolean	supportsAgendaSearch()	Tests if searching agendas is supported.
boolean	supportsAgendaSearchRecordType(Type agendaSearchRecordType)	Tests if the given Agenda search record type is supported.
boolean	supportsAgendaSmartEngine()	Tests if an agenda smart engine lookup service is supported.
boolean	supportsCheckAdmin()	Tests if check administrative service is supported.
boolean	supportsCheckConditionRecordType(Type checkConditionRecordType)	Tests if the given CheckCondition record type is supported.
boolean	supportsCheckEngine()	Tests if a check engine lookup service is supported.
boolean	supportsCheckEngineAssignment()	Tests if a check engine service is supported.
boolean	supportsCheckEvaluation()	Tests if evaluating checks is supported.
boolean	supportsCheckLookup()	Tests if looking up checks is supported.
boolean	supportsCheckNotification()	Tests if a check notification service is supported.
boolean	supportsCheckQuery()	Tests if querying checks is supported.
boolean	supportsCheckRecordType(Type checkRecordType)	Tests if the given Check record type is supported.
boolean	supportsCheckResultRecordType(Type checkResultRecordType)	Tests if the given CheckResult record type is supported.
boolean	supportsCheckSearch()	Tests if searching checks is supported.
boolean	supportsCheckSearchRecordType(Type checkSearchRecordType)	Tests if the given Check search record type is supported.
boolean	supportsCheckSmartEngine()	Tests if a check smart engine lookup service is supported.
boolean	supportsInstructionAdmin()	Tests if instruction administrative service is supported.
boolean	supportsInstructionApplicability()	Tests if evaluating instruction applicability is supported.
boolean	supportsInstructionConditionRecordType(Type instructionConditionRecordType)	Tests if the given InstructionCondition record type is supported.
boolean	supportsInstructionEngine()	Tests if an instruction engine lookup service is supported.
boolean	supportsInstructionEngineAssignment()	Tests if an instruction engine assignment service is supported.
boolean	supportsInstructionLookup()	Tests if looking up instructions is supported.
boolean	supportsInstructionNotification()	Tests if an instruction notification service is supported.
boolean	supportsInstructionQuery()	Tests if querying instructions is supported.
boolean	supportsInstructionRecordType(Type instructionRecordType)	Tests if the given Instruction record type is supported.
boolean	supportsInstructionSearch()	Tests if searching instructions is supported.
boolean	supportsInstructionSearchRecordType(Type instructionSearchRecordType)	Tests if the given Instruction search type is supported.
boolean	supportsInstructionSmartEngine()	Tests if an instruction smart engine service is supported.
boolean	supportsVisibleFederation()	Tests if any engine federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getAgendaSession

AgendaSession getAgendaSession()
                        throws OperationFailedException

Gets the OsidSession associated with the agenda evaluation service.

Returns:

an AgendaSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgenda() is false

Compliance:

optional - This method must be implemented if {@code supportsAgenda()} is {@code true} .

getAgendaSessionForEngine

AgendaSession getAgendaSessionForEngine(Id engineId)
                                 throws NotFoundException,
OperationFailedException

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

Parameters:

engineId - the Id of the engine

Returns:

an AgendaSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgenda() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAgenda()} and {@code supportsVisibleFederation()} are {@code true}

getAgendaEvaluationSession

AgendaEvaluationSession getAgendaEvaluationSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the agenda evaluation service.

Returns:

an AgendaEvaluationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaEvaluation() is false

Compliance:

optional - This method must be implemented if {@code supportsAgendaEvaluation()} is {@code true} .

getAgendaEvaluationSessionForEngine

AgendaEvaluationSession getAgendaEvaluationSessionForEngine(Id engineId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

engineId - the Id of the engine

Returns:

an AgendaEvaluationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgendaEvaluation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAgendaEvaluation()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaLookup()} is {@code 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 {@code supportsAgendaLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaQuery()} is {@code 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 {@code supportsAgendaQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaSearch()} is {@code 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 {@code supportsAgendaSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaAdmin()} is {@code 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 {@code supportsAgendaAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaNotification()} is {@code 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 {@code supportsAgendaNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaEngine()} is {@code 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 {@code supportsAgendaEngineAssignment()} is {@code 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 {@code supportsAgendaSmartEngine()} is {@code true} .

getInstructionApplicabilitySession

InstructionApplicabilitySession getInstructionApplicabilitySession()
                                                            throws OperationFailedException

Gets the OsidSession associated with the instruction applicability service.

Returns:

an InstructionApplicabilitySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionApplicability() is false

Compliance:

optional - This method must be implemented if {@code supportsInstructionApplicability()} is {@code true} .

getInstructionApplicabilitySessionForEngine

InstructionApplicabilitySession getInstructionApplicabilitySessionForEngine(Id engineId)
                                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

engineId - the Id of the engine

Returns:

an InstructionApplicabilitySession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInstructionApplicability() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsInstructionApplicability()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionLookup()} is {@code 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 {@code supportsInstructionLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionQuery()} is {@code 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 {@code supportsInstructionQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionSearch()} is {@code 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 {@code supportsInstructionSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionAdmin()} is {@code 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 {@code supportsInstructionAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionNotification()} is {@code 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 {@code supportsInstructionNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionEngine()} is {@code 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 {@code supportsInstructionEngineAssignment()} is {@code 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 {@code supportsInstructionSmartEngine()} is {@code true} .

getCheckEvaluationSession

CheckEvaluationSession getCheckEvaluationSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the check evaluation service.

Returns:

a CheckEvaluationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckEvaluation() is false

Compliance:

optional - This method must be implemented if {@code supportsCheckEvaluation()} is {@code true} .

getCheckEvaluationSessionForEngine

CheckEvaluationSession getCheckEvaluationSessionForEngine(Id engineId)
                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

engineId - the Id of the Engine

Returns:

a CheckEvaluationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCheckEvaluation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCheckEvaluation()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckLookup()} is {@code 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 {@code supportsCheckLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckQuery()} is {@code 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 {@code supportsCheckQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckSearch()} is {@code 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 {@code supportsCheckSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckAdmin()} is {@code 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 {@code supportsCheckAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckNotification()} is {@code 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 {@code supportsCheckNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckEngine()} is {@code 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 {@code supportsCheckEngineAssignment()} is {@code 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 {@code supportsCheckSmartEngine()} is {@code true} .