Interface RulesCheckProxyManager

All Superinterfaces:

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

• 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(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.
AgendaEvaluationSession	getAgendaEvaluationSession(Proxy proxy)	Gets the OsidSession associated with the agenda evaluation service.
AgendaEvaluationSession	getAgendaEvaluationSessionForEngine(Id engineId, Proxy proxy)	Gets the OsidSession associated with the agenda evaluation service for the given engine.
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.
AgendaSession	getAgendaSession(Proxy proxy)	Gets the OsidSession associated with the evaluation service to evaluate an agenda.
AgendaSession	getAgendaSessionForEngine(Id engineId, Proxy proxy)	Gets the OsidSession associated with the evaluation 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.
CheckEvaluationSession	getCheckEvaluationSession(Proxy proxy)	Gets the OsidSession associated with the check evaluation service.
CheckEvaluationSession	getCheckEvaluationSessionForEngine(Id engineId, Proxy proxy)	Gets the OsidSession associated with the check evaluation service for the given engine.
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.
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.
InstructionApplicabilitySession	getInstructionApplicabilitySession(Proxy proxy)	Gets the OsidSession associated with the instruction applicability service.
InstructionApplicabilitySession	getInstructionApplicabilitySessionForEngine(Id engineId, Proxy proxy)	Gets the OsidSession associated with the instruction applicability 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.

Methods inherited from interface Closeable

close

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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

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

Parameters:

proxy - a proxy

Returns:

an AgendaSession

Throws:

NullArgumentException - proxy is null

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,
 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 AgendaSession

Throws:

NotFoundException - no Engine found by the given Id

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

Gets the OsidSession associated with the agenda evaluation service.

Parameters:

proxy - a proxy

Returns:

a AgendaEvaluationSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

engineId - the Id of the engine

proxy - a proxy

Returns:

a AgendaEvaluationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(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 {@code supportsAgendaLookup()} is {@code 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 {@code supportsAgendaLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaQuery()} is {@code 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 {@code supportsAgendaQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaSearch()} is {@code 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 {@code supportsAgendaSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaAdmin()} is {@code 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 {@code supportsAgendaAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaNotification()} is {@code 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 {@code supportsAgendaNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAgendaEngine()} is {@code 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 {@code supportsAgendaEngineAssignment()} is {@code 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 {@code supportsAgendaSmartEngine()} is {@code true} .

getInstructionApplicabilitySession

InstructionApplicabilitySession getInstructionApplicabilitySession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the instruction applicability service.

Parameters:

proxy - a proxy

Returns:

an InstructionApplicabilitySession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

engineId - the Id of the engine

proxy - a proxy

Returns:

an InstructionApplicabilitySession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(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 {@code supportsInstructionLookup()} is {@code 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 {@code supportsInstructionLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionQuery()} is {@code 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 {@code supportsInstructionQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionSearch()} is {@code 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 {@code supportsInstructionSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionAdmin()} is {@code 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 {@code supportsInstructionAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionNotification()} is {@code 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 {@code supportsInstructionNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInstructionEngine()} is {@code 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 {@code supportsInstructionEngineAssignment()} is {@code 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 {@code supportsInstructionSmartEngine()} is {@code true} .

getCheckEvaluationSession

CheckEvaluationSession getCheckEvaluationSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the check evaluation service.

Parameters:

proxy - a proxy

Returns:

a CheckEvaluationSession

Throws:

NullArgumentException - proxy is null

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

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

Parameters:

engineId - the Id of the Engine

proxy - a proxy

Returns:

a CheckEvaluationSession

Throws:

NotFoundException - no Engine found by the given Id

NullArgumentException - engineId or proxy 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(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 {@code supportsCheckLookup()} is {@code 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 {@code supportsCheckLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckQuery()} is {@code 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 {@code supportsCheckQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckSearch()} is {@code 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 {@code supportsCheckSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckAdmin()} is {@code 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 {@code supportsCheckAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckNotification()} is {@code 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 {@code supportsCheckNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCheckEngine()} is {@code 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 {@code supportsCheckEngineAssignment()} is {@code 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 {@code supportsCheckSmartEngine()} is {@code true} .