public interface RulesCheckProxyManager extends OsidProxyManager, RulesCheckProfile
The check proxy manager provides access to rules sessions and provides
interoperability tests for various aspects of this service. Methods in
this manager pass a Proxy
for passing information from
server environments. The sessions included in this manager are:
EvaluationSession:
a session for evaluating
agendas ProcessingSession:
a session for processing
agendas AgendaLookupSession:
a session to retrieve agendas
AgendaQuerySession:
a session to query for agendas
AgendaSearchSession:
a session to search for
agendas AgendaAdminSession:
a session to create and delete
agendas AgendaNotificationSession:
a session to receive
notifications pertaining to agenda changes AgendaEngineSession:
a session to looking mappings
of agendas to engines AgendaEngineAssignmentSession:
a session to manage
agenda to engine mappings AgendaEngineAssignmentSession:
a session to manage
dynamic engines of agendas InstructionLookupSession:
a session to retrieve
instructions InstructionQuerySession:
a session to query for
instructions InstructionSearchSession:
a session to search for
instructions InstructionAdminSession:
a session to create and
delete instructions InstructionNotificationSession:
a session to
receive notifications pertaining to instruction changes InstructionEngineSession:
a session to look up
instruction engine mappings InstructionEngineAssignmentSession:
a session to
manage instruction to engine mappings InstructionSmartEngineSession:
a session to manage
dynamic engines of instructions CheckLookupSession:
a session to retrieve check
CheckQuerySession:
a session to query for check
CheckSearchSession:
a session to search for check
CheckAdminSession:
a session to create and delete
checks CheckNotificationSession:
a session to receive
notifications pertaining to check changes CheckEngineSession:
a session to look up check
engine mappings CheckEngineAssignmentSession:
a session to manage
check to engine mappings CheckSmartEngineSession:
a session to manage
dynamic engines of checks Modifier and Type | Method and Description |
---|---|
AgendaAdminSession |
getAgendaAdminSession(Proxy proxy)
Gets the
OsidSession associated with the agenda
administration service. |
AgendaAdminSession |
getAgendaAdminSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the agenda
administration service for the given engine. |
AgendaEngineAssignmentSession |
getAgendaEngineAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning agendas
to engines. |
AgendaEngineSession |
getAgendaEngineSession(Proxy proxy)
Gets the
OsidSession to lookup agenda/engine mappings. |
AgendaLookupSession |
getAgendaLookupSession(Proxy proxy)
Gets the
OsidSession associated with the agenda lookup
service. |
AgendaLookupSession |
getAgendaLookupSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the agenda lookup
service for the given engine. |
AgendaNotificationSession |
getAgendaNotificationSession(AgendaReceiver agendaReceiver,
Proxy proxy)
Gets the
OsidSession associated with the agenda
notification service. |
AgendaNotificationSession |
getAgendaNotificationSessionForEngine(AgendaReceiver agendaReceiver,
Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the agenda
notification service for the given engine. |
AgendaQuerySession |
getAgendaQuerySession(Proxy proxy)
Gets the
OsidSession associated with the agenda query
service. |
AgendaQuerySession |
getAgendaQuerySessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the agenda query
service for the given engine. |
AgendaSearchSession |
getAgendaSearchSession(Proxy proxy)
Gets the
OsidSession associated with the agenda search
service. |
AgendaSearchSession |
getAgendaSearchSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the agenda search
service for the given engine. |
AgendaSmartEngineSession |
getAgendaSmartEngineSession(Id engineId,
Proxy proxy)
Gets the
OsidSession to manage agenda smart engines. |
CheckAdminSession |
getCheckAdminSession(Proxy proxy)
Gets the
OsidSession associated with the check
administrative service. |
CheckAdminSession |
getCheckAdminSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the check
administrative service for the given engine. |
CheckEngineAssignmentSession |
getCheckEngineAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning
competencies to engines. |
CheckEngineSession |
getCheckEngineSession(Proxy proxy)
Gets the
OsidSession to lookup check/engine mappings. |
CheckLookupSession |
getCheckLookupSession(Proxy proxy)
Gets the
OsidSession associated with the check lookup
service. |
CheckLookupSession |
getCheckLookupSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the check lookup
service for the given engine. |
CheckNotificationSession |
getCheckNotificationSession(CheckReceiver checkReceiver,
Proxy proxy)
Gets the
OsidSession associated with the check
notification service. |
CheckNotificationSession |
getCheckNotificationSessionForEngine(CheckReceiver checkReceiver,
Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the check
notification service for the given engine. |
CheckQuerySession |
getCheckQuerySession(Proxy proxy)
Gets the
OsidSession associated with the check query
service. |
CheckQuerySession |
getCheckQuerySessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the check query
service for the given engine. |
CheckSearchSession |
getCheckSearchSession(Proxy proxy)
Gets the
OsidSession associated with the check search
service. |
CheckSearchSession |
getCheckSearchSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the check search
service for the given engine. |
CheckSmartEngineSession |
getCheckSmartEngineSession(Id engineId,
Proxy proxy)
Gets the
OsidSession to manage check smart engines. |
EvaluationSession |
getEvaluationSession(Proxy proxy)
Gets the
OsidSession associated with the evaluation
service to evaluate an agenda. |
EvaluationSession |
getEvaluationSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the evaluation
service for the given engine. |
InstructionAdminSession |
getInstructionAdminSession(Proxy proxy)
Gets the
OsidSession associated with the instruction
administration service. |
InstructionAdminSession |
getInstructionAdminSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the instruction
administration service for the given engine. |
InstructionEngineAssignmentSession |
getInstructionEngineAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning mappings
to engines. |
InstructionEngineSession |
getInstructionEngineSession(Proxy proxy)
Gets the
OsidSession to lookup instruction/engine
checks. |
InstructionLookupSession |
getInstructionLookupSession(Proxy proxy)
Gets the
OsidSession associated with the instruction
lookup service. |
InstructionLookupSession |
getInstructionLookupSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the instruction
lookup service for the given engine. |
InstructionNotificationSession |
getInstructionNotificationSession(InstructionReceiver instructionReceiver,
Proxy proxy)
Gets the
OsidSession associated with the instruction
notification service. |
InstructionNotificationSession |
getInstructionNotificationSessionForEngine(InstructionReceiver instructionReceiver,
Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the instruction
notification service for the given engine. |
InstructionQuerySession |
getInstructionQuerySession(Proxy proxy)
Gets the
OsidSession associated with the instruction
query service. |
InstructionQuerySession |
getInstructionQuerySessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the instruction
query service for the given engine. |
InstructionSearchSession |
getInstructionSearchSession(Proxy proxy)
Gets the
OsidSession associated with the instruction
search service. |
InstructionSearchSession |
getInstructionSearchSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the instruction
search service for the given engine. |
InstructionSmartEngineSession |
getInstructionSmartEngineSession(Id engineId,
Proxy proxy)
Gets the
OsidSession to manage locatin smart engines. |
ProcessingSession |
getProcessingSession(Proxy proxy)
Gets the
OsidSession associated with the processing
service to run checks. |
ProcessingSession |
getProcessingSessionForEngine(Id engineId,
Proxy proxy)
Gets the
OsidSession associated with the processing
service for the given engine. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the evaluation
service to evaluate an agenda.proxy
- a proxy EvaluationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEvaluation()
is false
optional
- This method must be implemented if
supportsEvaluation()
is true.
EvaluationSession getEvaluationSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the evaluation
service for the given engine.engineId
- the Id
of the engineproxy
- a proxy EvaluationSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the processing
service to run checks.proxy
- a proxy ProcessingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessing()
is false
optional
- This method must be implemented if
supportsProcessing()
is true.
ProcessingSession getProcessingSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the processing
service for the given engine.engineId
- the Id
of the engineproxy
- a proxy ProcessingSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agenda lookup
service.proxy
- a proxy AgendaLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaLookup()
is false
optional
- This method must be implemented if
supportsAgendaLookup()
is true.
AgendaLookupSession getAgendaLookupSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda lookup
service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy AgendaLookupSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agenda query
service.proxy
- a proxy AgendaQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaQuery()
is false
optional
- This method must be implemented if
supportsAgendaQuery()
is true.
AgendaQuerySession getAgendaQuerySessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda query
service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy AgendaQuerySession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agenda search
service.proxy
- a proxy AgendaSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaSearch()
is false
optional
- This method must be implemented if
supportsAgendaSearch()
is true.
AgendaSearchSession getAgendaSearchSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda search
service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy AgendaSearchSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the agenda
administration service.proxy
- a proxy AgendaAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaAdmin()
is false
optional
- This method must be implemented if
supportsAgendaAdmin()
is true.
AgendaAdminSession getAgendaAdminSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda
administration service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy AgendaAdminSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the agenda
notification service.agendaReceiver
- the notification callbackproxy
- a proxy AgendaNotificationSession
NullArgumentException
- agendaReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the agenda
notification service for the given engine.agendaReceiver
- the notification callbackengineId
- the Id
of the Engine
proxy
- a proxy AgendaNotificationSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- agendaReceiver, engineId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup agenda/engine mappings.proxy
- a proxy AgendaEngineSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAgendaEngine()
is false
optional
- This method must be implemented if
supportsAgendaEngine()
is true.
AgendaEngineAssignmentSession getAgendaEngineAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning agendas
to engines.proxy
- a proxy AgendaEngineAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgendaEngineAssignment()
is false
optional
- This method must be implemented if
supportsAgendaEngineAssignment()
is true.
AgendaSmartEngineSession getAgendaSmartEngineSession(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage agenda smart engines.engineId
- the Id
of the Engine
proxy
- a proxy AgendaSmartEngineSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgendaSmartEngine()
is false
optional
- This method must be implemented if
supportsAgendaSmartEngine()
is true.
InstructionLookupSession getInstructionLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the instruction
lookup service.proxy
- a proxy InstructionLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionLookup()
is false
optional
- This method must be implemented if
supportsInstructionLookup()
is true.
InstructionLookupSession getInstructionLookupSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
lookup service for the given engine.engineId
- the Id
of the engineproxy
- a proxy InstructionLookupSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the instruction
query service.proxy
- a proxy InstructionQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionQuery()
is false
optional
- This method must be implemented if
supportsInstructionQuery()
is true.
InstructionQuerySession getInstructionQuerySessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
query service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy InstructionQuerySession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the instruction
search service.proxy
- a proxy InstructionSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionSearch()
is false
optional
- This method must be implemented if
supportsInstructionSearch()
is true.
InstructionSearchSession getInstructionSearchSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
search service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy InstructionSearchSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the instruction
administration service.proxy
- a proxy InstructionAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionAdmin()
is false
optional
- This method must be implemented if
supportsInstructionAdmin()
is true.
InstructionAdminSession getInstructionAdminSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
administration service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy InstructionAdminSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId or proxy 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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the instruction
notification service.instructionReceiver
- the notification callbackproxy
- a proxy InstructionNotificationSession
NullArgumentException
- instructionReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the instruction
notification service for the given engine.instructionReceiver
- the notification callbackengineId
- the Id
of the Engine
proxy
- a proxy InstructionNotificationSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- instructionReceiver,
engineId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup instruction/engine
checks.proxy
- a proxy InstructionEngineSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionEngine()
is false
optional
- This method must be implemented if
supportsInstructionEngine()
is true.
InstructionEngineAssignmentSession getInstructionEngineAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning mappings
to engines.proxy
- a proxy InstructionEngineAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionEngineAssignment()
is false
optional
- This method must be implemented if
supportsInstructionEngineAssignment()
is
true.
InstructionSmartEngineSession getInstructionSmartEngineSession(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart engines.engineId
- the Id
of the Engine
proxy
- a proxy InstructionSmartEngineSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInstructionSmartEngine()
is false
optional
- This method must be implemented if
supportsInstructionSmartEngine()
is true.
CheckLookupSession getCheckLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the check lookup
service.proxy
- a proxy CheckLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckLookup()
is false
optional
- This method must be implemented if
supportsCheckLookup()
is true.
CheckLookupSession getCheckLookupSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the check lookup
service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy CheckLookupSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the check query
service.proxy
- a proxy CheckQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckQuery()
is false
optional
- This method must be implemented if
supportsCheckQuery()
is true.
CheckQuerySession getCheckQuerySessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the check query
service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy CheckQuerySession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the check search
service.proxy
- a proxy CheckSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckSearch()
is false
optional
- This method must be implemented if
supportsCheckSearch()
is true.
CheckSearchSession getCheckSearchSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the check search
service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy CheckSearchSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId or proxy 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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the check
administrative service.proxy
- a proxy CheckAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckAdmin()
is false
optional
- This method must be implemented if
supportsCheckAdmin()
is true.
CheckAdminSession getCheckAdminSessionForEngine(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the check
administrative service for the given engine.engineId
- the Id
of the Engine
proxy
- a proxy CheckAdminSession
NotFoundException
- no Engine
found by
the given Id
NullArgumentException
- engineId or proxy 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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the check
notification service.checkReceiver
- the notification callbackproxy
- a proxy CheckNotificationSession
NullArgumentException
- checkReceiver
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the check
notification service for the given engine.checkReceiver
- the notification callbackengineId
- the Id
of the Engine
proxy
- a proxy CheckNotificationSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- checkReceiver, engineId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup check/engine mappings.proxy
- a proxy CheckEngineSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCheckEngine()
is false
optional
- This method must be implemented if
supportsCheckEngine()
is true.
CheckEngineAssignmentSession getCheckEngineAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning
competencies to engines.proxy
- a proxy CheckEngineAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCheckEngineAssignment()
is false
optional
- This method must be implemented if
supportsCheckEngineAssignment()
is true.
CheckSmartEngineSession getCheckSmartEngineSession(Id engineId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage check smart engines.engineId
- the Id
of the Engine
proxy
- a proxy CheckSmartEngineSession
NotFoundException
- no engine found by the given
Id
NullArgumentException
- engineId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCheckSmartEngine()
is false
optional
- This method must be implemented if
supportsCheckSmartEngine()
is true.