public interface RulesCheckManager extends OsidManager, RulesCheckProfile
The check manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
EvaluationSession:
a session for evaluating
agendas ProcessingSession:
a session for processing
agendas AgendaLookupSession:
a session to retrieve agendas
AgendaQuerySession:
a session to query for agendas
AgendaSearchSession:
a session to search for
agendas AgendaAdminSession:
a session to create and delete
agendas AgendaNotificationSession:
a session to receive
notifications pertaining to agenda changes AgendaEngineSession:
a session to looking mappings
of agendas to engines AgendaEngineAssignmentSession:
a session to manage
agenda to engine mappings AgendaEngineAssignmentSession:
a session to manage
dynamic engines of agendas InstructionLookupSession:
a session to retrieve
instructions InstructionQuerySession:
a session to query for
instructions InstructionSearchSession:
a session to search for
instructions InstructionAdminSession:
a session to create and
delete instructions InstructionNotificationSession:
a session to
receive notifications pertaining to instruction changes InstructionEngineSession:
a session to look up
instruction engine mappings InstructionEngineAssignmentSession:
a session to
manage instruction to engine mappings InstructionSmartEngineSession:
a session to manage
dynamic engines of instructions CheckLookupSession:
a session to retrieve checks
CheckQuerySession:
a session to query for checks
CheckSearchSession:
a session to search for checks
CheckAdminSession:
a session to create and delete
checks CheckNotificationSession:
a session to receive
notifications pertaining to check changes CheckEngineSession:
a session to look up check
engine mappings CheckEngineAssignmentSession:
a session to manage
check to engine mappings CheckSmartEngineSession:
a session to manage
dynamic engines of checks Modifier and Type | Method and Description |
---|---|
AgendaAdminSession |
getAgendaAdminSession()
Gets the
OsidSession associated with the agenda
administration service. |
AgendaAdminSession |
getAgendaAdminSessionForEngine(Id engineId)
Gets the
OsidSession associated with the agenda
administration service for the given engine. |
AgendaEngineAssignmentSession |
getAgendaEngineAssignmentSession()
Gets the
OsidSession associated with assigning agendas
to engines. |
AgendaEngineSession |
getAgendaEngineSession()
Gets the
OsidSession to lookup agenda/engine mappings. |
AgendaLookupSession |
getAgendaLookupSession()
Gets the
OsidSession associated with the agenda lookup
service. |
AgendaLookupSession |
getAgendaLookupSessionForEngine(Id engineId)
Gets the
OsidSession associated with the agenda lookup
service for the given engine. |
AgendaNotificationSession |
getAgendaNotificationSession(AgendaReceiver agendaReceiver)
Gets the
OsidSession associated with the agenda
notification service. |
AgendaNotificationSession |
getAgendaNotificationSessionForEngine(AgendaReceiver agendaReceiver,
Id engineId)
Gets the
OsidSession associated with the agenda
notification service for the given engine. |
AgendaQuerySession |
getAgendaQuerySession()
Gets the
OsidSession associated with the agenda query
service. |
AgendaQuerySession |
getAgendaQuerySessionForEngine(Id engineId)
Gets the
OsidSession associated with the agenda query
service for the given engine. |
AgendaSearchSession |
getAgendaSearchSession()
Gets the
OsidSession associated with the agenda search
service. |
AgendaSearchSession |
getAgendaSearchSessionForEngine(Id engineId)
Gets the
OsidSession associated with the agenda search
service for the given engine. |
AgendaSmartEngineSession |
getAgendaSmartEngineSession(Id engineId)
Gets the
OsidSession to manage agenda smart engines. |
CheckAdminSession |
getCheckAdminSession()
Gets the
OsidSession associated with the check
administrative service. |
CheckAdminSession |
getCheckAdminSessionForEngine(Id engineId)
Gets the
OsidSession associated with the check
administrative service for the given engine. |
CheckEngineAssignmentSession |
getCheckEngineAssignmentSession()
Gets the
OsidSession associated with assigning
competencies to engines. |
CheckEngineSession |
getCheckEngineSession()
Gets the
OsidSession to lookup check/engine mappings. |
CheckLookupSession |
getCheckLookupSession()
Gets the
OsidSession associated with the check lookup
service. |
CheckLookupSession |
getCheckLookupSessionForEngine(Id engineId)
Gets the
OsidSession associated with the check lookup
service for the given engine. |
CheckNotificationSession |
getCheckNotificationSession(CheckReceiver checkReceiver)
Gets the
OsidSession associated with the check
notification service. |
CheckNotificationSession |
getCheckNotificationSessionForEngine(CheckReceiver checkReceiver,
Id engineId)
Gets the
OsidSession associated with the check
notification service for the given engine. |
CheckQuerySession |
getCheckQuerySession()
Gets the
OsidSession associated with the check query
service. |
CheckQuerySession |
getCheckQuerySessionForEngine(Id engineId)
Gets the
OsidSession associated with the check query
service for the given engine. |
CheckSearchSession |
getCheckSearchSession()
Gets the
OsidSession associated with the check search
service. |
CheckSearchSession |
getCheckSearchSessionForEngine(Id engineId)
Gets the
OsidSession associated with the check search
service for the given engine. |
CheckSmartEngineSession |
getCheckSmartEngineSession(Id engineId)
Gets the
OsidSession to manage check smart engines. |
EvaluationSession |
getEvaluationSession()
Gets the
OsidSession associated with the evaluation
service to evaluate an agenda. |
EvaluationSession |
getEvaluationSessionForEngine(Id engineId)
Gets the
OsidSession associated with the evaluation
service for the given engine. |
InstructionAdminSession |
getInstructionAdminSession()
Gets the
OsidSession associated with the instruction
administration service. |
InstructionAdminSession |
getInstructionAdminSessionForEngine(Id engineId)
Gets the
OsidSession associated with the instruction
administration service for the given engine. |
InstructionEngineAssignmentSession |
getInstructionEngineAssignmentSession()
Gets the
OsidSession associated with assigning
instructions to engines. |
InstructionEngineSession |
getInstructionEngineSession()
Gets the
OsidSession to lookup instruction/engine
checks. |
InstructionLookupSession |
getInstructionLookupSession()
Gets the
OsidSession associated with the instruction
lookup service. |
InstructionLookupSession |
getInstructionLookupSessionForEngine(Id engineId)
Gets the
OsidSession associated with the instruction
lookup service for the given engine. |
InstructionNotificationSession |
getInstructionNotificationSession(InstructionReceiver instructionReceiver)
Gets the
OsidSession associated with the instruction
notification service. |
InstructionNotificationSession |
getInstructionNotificationSessionForEngine(InstructionReceiver instructionReceiver,
Id engineId)
Gets the
OsidSession associated with the instruction
notification service for the given engine. |
InstructionQuerySession |
getInstructionQuerySession()
Gets the
OsidSession associated with the instruction
query service. |
InstructionQuerySession |
getInstructionQuerySessionForEngine(Id engineId)
Gets the
OsidSession associated with the instruction
query service for the given engine. |
InstructionSearchSession |
getInstructionSearchSession()
Gets the
OsidSession associated with the instruction
search service. |
InstructionSearchSession |
getInstructionSearchSessionForEngine(Id engineId)
Gets the
OsidSession associated with the instruction
search service for the given engine. |
InstructionSmartEngineSession |
getInstructionSmartEngineSession(Id engineId)
Gets the
OsidSession to manage locatin smart engines. |
ProcessingSession |
getProcessingSession()
Gets the
OsidSession associated with the processing
service to run checks. |
ProcessingSession |
getProcessingSessionForEngine(Id engineId)
Gets the
OsidSession associated with the processing
service for the given engine. |
changeBranch, initialize, rollbackService
close
getAgendaRecordTypes, getAgendaSearchRecordTypes, getCheckRecordTypes, getCheckResultRecordTypes, getCheckSearchRecordTypes, getInstructionRecordTypes, getInstructionSearchRecordTypes, supportsAgendaAdmin, supportsAgendaEngine, supportsAgendaEngineAssignment, supportsAgendaLookup, supportsAgendaNotification, supportsAgendaQuery, supportsAgendaRecordType, supportsAgendaSearch, supportsAgendaSearchRecordType, supportsAgendaSmartEngine, supportsCheckAdmin, supportsCheckEngine, supportsCheckEngineAssignment, supportsCheckLookup, supportsCheckNotification, supportsCheckQuery, supportsCheckRecordType, supportsCheckResultRecordType, supportsCheckSearch, supportsCheckSearchRecordType, supportsCheckSmartEngine, supportsEvaluation, supportsInstructionAdmin, supportsInstructionEngine, supportsInstructionEngineAssignment, supportsInstructionLookup, supportsInstructionNotification, supportsInstructionQuery, supportsInstructionRecordType, supportsInstructionSearch, supportsInstructionSearchRecordType, supportsInstructionSmartEngine, supportsProcessing, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
EvaluationSession getEvaluationSession() throws OperationFailedException
OsidSession
associated with the evaluation
service to evaluate an agenda. EvaluationSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEvaluation()
is false
optional
- This method must be implemented if
supportsEvaluation()
is true.
EvaluationSession getEvaluationSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the evaluation
service for the given engine.engineId
- the Id
of the engine EvaluationSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEvaluation()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEvaluation()
and
supportsVisibleFederation()
are true
ProcessingSession getProcessingSession() throws OperationFailedException
OsidSession
associated with the processing
service to run checks. ProcessingSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessing()
is false
optional
- This method must be implemented if
supportsProcessing()
is true.
ProcessingSession getProcessingSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the processing
service for the given engine.engineId
- the Id
of the engine ProcessingSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessing()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProcessing()
and
supportsVisibleFederation()
are true
AgendaLookupSession getAgendaLookupSession() throws OperationFailedException
OsidSession
associated with the agenda lookup
service. AgendaLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaLookup()
is false
optional
- This method must be implemented if
supportsAgendaLookup()
is true.
AgendaLookupSession getAgendaLookupSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda lookup
service for the given engine.engineId
- the Id
of the Engine
AgendaLookupSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgendaLookup()
and
supportsVisibleFederation()
are true
AgendaQuerySession getAgendaQuerySession() throws OperationFailedException
OsidSession
associated with the agenda query
service. AgendaQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaQuery()
is false
optional
- This method must be implemented if
supportsAgendaQuery()
is true.
AgendaQuerySession getAgendaQuerySessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda query
service for the given engine.engineId
- the Id
of the Engine
AgendaQuerySession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgendaQuery()
and
supportsVisibleFederation()
are true
AgendaSearchSession getAgendaSearchSession() throws OperationFailedException
OsidSession
associated with the agenda search
service. AgendaSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaSearch()
is false
optional
- This method must be implemented if
supportsAgendaSearch()
is true.
AgendaSearchSession getAgendaSearchSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda search
service for the given engine.engineId
- the Id
of the Engine
AgendaSearchSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgendaSearch()
and
supportsVisibleFederation()
are true
AgendaAdminSession getAgendaAdminSession() throws OperationFailedException
OsidSession
associated with the agenda
administration service. AgendaAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaAdmin()
is false
optional
- This method must be implemented if
supportsAgendaAdmin()
is true.
AgendaAdminSession getAgendaAdminSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda
administration service for the given engine.engineId
- the Id
of the Engine
AgendaAdminSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsAgendaAdmin()
and
supportsVisibleFederation()
are true
AgendaNotificationSession getAgendaNotificationSession(AgendaReceiver agendaReceiver) throws OperationFailedException
OsidSession
associated with the agenda
notification service.agendaReceiver
- the notification callback AgendaNotificationSession
NullArgumentException
- agendaReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgendaNotification()
is false
optional
- This method must be implemented if
supportsAgendaNotification()
is true.
AgendaNotificationSession getAgendaNotificationSessionForEngine(AgendaReceiver agendaReceiver, Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda
notification service for the given engine.agendaReceiver
- the notification callbackengineId
- the Id
of the Engine
AgendaNotificationSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- agendaReceiver
or engineId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgendaNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAgendaNotification()
and
supportsVisibleFederation()
are true
AgendaEngineSession getAgendaEngineSession() throws OperationFailedException
OsidSession
to lookup agenda/engine mappings. AgendaEngineSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaEngine()
is false
optional
- This method must be implemented if
supportsAgendaEngine()
is true.
AgendaEngineAssignmentSession getAgendaEngineAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning agendas
to engines. AgendaEngineAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgendaEngineAssignment()
is false
optional
- This method must be implemented if
supportsAgendaEngineAssignment()
is true.
AgendaSmartEngineSession getAgendaSmartEngineSession(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
to manage agenda smart engines.engineId
- the Id
of the Engine
AgendaSmartEngineSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgendaSmartEngine()
is false
optional
- This method must be implemented if
supportsAgendaSmartEngine()
is true.
InstructionLookupSession getInstructionLookupSession() throws OperationFailedException
OsidSession
associated with the instruction
lookup service. InstructionLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionLookup()
is false
optional
- This method must be implemented if
supportsInstructionLookup()
is true.
InstructionLookupSession getInstructionLookupSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
lookup service for the given engine.engineId
- the Id
of the engine InstructionLookupSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstructionLookup()
and
supportsVisibleFederation()
are true
InstructionQuerySession getInstructionQuerySession() throws OperationFailedException
OsidSession
associated with the instruction
query service. InstructionQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionQuery()
is false
optional
- This method must be implemented if
supportsInstructionQuery()
is true.
InstructionQuerySession getInstructionQuerySessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
query service for the given engine.engineId
- the Id
of the Engine
InstructionQuerySession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstructionQuery()
and
supportsVisibleFederation()
are true
InstructionSearchSession getInstructionSearchSession() throws OperationFailedException
OsidSession
associated with the instruction
search service. InstructionSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionSearch()
is false
optional
- This method must be implemented if
supportsInstructionSearch()
is true.
InstructionSearchSession getInstructionSearchSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
search service for the given engine.engineId
- the Id
of the Engine
InstructionSearchSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstructionSearch()
and
supportsVisibleFederation()
are true
InstructionAdminSession getInstructionAdminSession() throws OperationFailedException
OsidSession
associated with the instruction
administration service. InstructionAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionAdmin()
is false
optional
- This method must be implemented if
supportsInstructionAdmin()
is true.
InstructionAdminSession getInstructionAdminSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
administration service for the given engine.engineId
- the Id
of the Engine
InstructionAdminSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstructionAdmin()
and
supportsVisibleFederation()
are true
InstructionNotificationSession getInstructionNotificationSession(InstructionReceiver instructionReceiver) throws OperationFailedException
OsidSession
associated with the instruction
notification service.instructionReceiver
- the notification callback InstructionNotificationSession
NullArgumentException
- instructionReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionNotification()
is false
optional
- This method must be implemented if
supportsInstructionNotification()
is true.
InstructionNotificationSession getInstructionNotificationSessionForEngine(InstructionReceiver instructionReceiver, Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
notification service for the given engine.instructionReceiver
- the notification callbackengineId
- the Id
of the Engine
InstructionNotificationSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- instructionReceiver
or engineId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInstructionNotification()
and
supportsVisibleFederation()
are true
InstructionEngineSession getInstructionEngineSession() throws OperationFailedException
OsidSession
to lookup instruction/engine
checks. InstructionEngineSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionEngine()
is false
optional
- This method must be implemented if
supportsInstructionEngine()
is true.
InstructionEngineAssignmentSession getInstructionEngineAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
instructions to engines. InstructionEngineAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionEngineAssignment()
is false
optional
- This method must be implemented if
supportsInstructionEngineAssignment()
is
true.
InstructionSmartEngineSession getInstructionSmartEngineSession(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart engines.engineId
- the Id
of the Engine
InstructionSmartEngineSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionSmartEngine()
is false
optional
- This method must be implemented if
supportsInstructionSmartEngine()
is true.
CheckLookupSession getCheckLookupSession() throws OperationFailedException
OsidSession
associated with the check lookup
service. CheckLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckLookup()
is false
optional
- This method must be implemented if
supportsCheckLookup()
is true.
CheckLookupSession getCheckLookupSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the check lookup
service for the given engine.engineId
- the Id
of the Engine
CheckLookupSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCheckLookup()
and
supportsVisibleFederation()
are true
CheckQuerySession getCheckQuerySession() throws OperationFailedException
OsidSession
associated with the check query
service. CheckQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckQuery()
is false
optional
- This method must be implemented if
supportsCheckQuery()
is true.
CheckQuerySession getCheckQuerySessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the check query
service for the given engine.engineId
- the Id
of the Engine
CCheckQuerySession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCheckQuery()
and
supportsVisibleFederation()
are true
CheckSearchSession getCheckSearchSession() throws OperationFailedException
OsidSession
associated with the check search
service. CheckSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckSearch()
is false
optional
- This method must be implemented if
supportsCheckSearch()
is true.
CheckSearchSession getCheckSearchSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the check search
service for the given engine.engineId
- the Id
of the Engine
CheckSearchSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCheckSearch()
and
supportsVisibleFederation()
are true
CheckAdminSession getCheckAdminSession() throws OperationFailedException
OsidSession
associated with the check
administrative service. CheckAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckAdmin()
is false
optional
- This method must be implemented if
supportsCheckAdmin()
is true.
CheckAdminSession getCheckAdminSessionForEngine(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the check
administrative service for the given engine.engineId
- the Id
of the Engine
CheckAdminSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsCheckAdmin()
and
supportsVisibleFederation()
are true
CheckNotificationSession getCheckNotificationSession(CheckReceiver checkReceiver) throws OperationFailedException
OsidSession
associated with the check
notification service.checkReceiver
- the notification callback CheckNotificationSession
NullArgumentException
- checkReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCheckNotification()
is false
optional
- This method must be implemented if
supportsCheckNotification()
is true.
CheckNotificationSession getCheckNotificationSessionForEngine(CheckReceiver checkReceiver, Id engineId) throws NotFoundException, OperationFailedException
OsidSession
associated with the check
notification service for the given engine.checkReceiver
- the notification callbackengineId
- the Id
of the Engine
CheckNotificationSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- checkReceiver
or
engineId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCheckNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCheckNotification()
and
supportsVisibleFederation()
are true
CheckEngineSession getCheckEngineSession() throws OperationFailedException
OsidSession
to lookup check/engine mappings. CheckEngineSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckEngine()
is false
optional
- This method must be implemented if
supportsCheckEngine()
is true.
CheckEngineAssignmentSession getCheckEngineAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
competencies to engines. CheckEngineAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCheckEngineAssignment()
is false
optional
- This method must be implemented if
supportsCheckEngineAssignment()
is true.
CheckSmartEngineSession getCheckSmartEngineSession(Id engineId) throws NotFoundException, OperationFailedException
OsidSession
to manage check smart engines.engineId
- the Id
of the Engine
CheckSmartEngineSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCheckSmartEngine()
is false
optional
- This method must be implemented if
supportsCheckSmartEngine()
is true.