Interface | osid.rules.check.RulesCheckManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.rules.check.RulesCheckProfile | |||
Description |
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:
| ||
Method | getEvaluationSession | ||
Description |
Gets the | ||
Return | osid.rules.check.EvaluationSession | an EvaluationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsEvaluation() is false | ||
Compliance | optional | This method must be implemented if supportsEvaluation() is
true. | |
Method | getEvaluationSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the engine |
Return | osid.rules.check.EvaluationSession | an EvaluationSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEvaluation() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEvaluation() and
supportsVisibleFederation() are true | |
Method | getProcessingSession | ||
Description |
Gets the | ||
Return | osid.rules.check.ProcessingSession | a ProcessingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcessing() is false | ||
Compliance | optional | This method must be implemented if supportsProcessing() is
true. | |
Method | getProcessingSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the engine |
Return | osid.rules.check.ProcessingSession | a ProcessingSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcessing() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsProcessing() and
supportsVisibleFederation() are true | |
Method | getAgendaLookupSession | ||
Description |
Gets the | ||
Return | osid.rules.check.AgendaLookupSession | an AgendaLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgendaLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaLookup() is
true. | |
Method | getAgendaLookupSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.AgendaLookupSession | an AgendaLookupSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgendaLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgendaLookup()
and supportsVisibleFederation() are true | |
Method | getAgendaQuerySession | ||
Description |
Gets the | ||
Return | osid.rules.check.AgendaQuerySession | an AgendaQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgendaQuery() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaQuery() is
true. | |
Method | getAgendaQuerySessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.AgendaQuerySession | an AgendaQuerySession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgendaQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgendaQuery() and
supportsVisibleFederation() are true | |
Method | getAgendaSearchSession | ||
Description |
Gets the | ||
Return | osid.rules.check.AgendaSearchSession | an AgendaSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgendaSearch() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaSearch() is
true. | |
Method | getAgendaSearchSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.AgendaSearchSession | an AgendaSearchSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgendaSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgendaSearch()
and supportsVisibleFederation() are true | |
Method | getAgendaAdminSession | ||
Description |
Gets the | ||
Return | osid.rules.check.AgendaAdminSession | an AgendaAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgendaAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaAdmin() is
true. | |
Method | getAgendaAdminSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.AgendaAdminSession | an AgendaAdminSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgendaAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsAgendaAdmin() and
supportsVisibleFederation() are true | |
Method | getAgendaNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.rules.check.AgendaReceiver | agendaReceiver | the notification callback |
Return | osid.rules.check.AgendaNotificationSession | an AgendaNotificationSession | |
Errors | NULL_ARGUMENT | agendaReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgendaNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaNotification()
is true. | |
Method | getAgendaNotificationSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.rules.check.AgendaReceiver | agendaReceiver | the notification callback |
osid.id.Id | engineId | the Id of the Engine | |
Return | osid.rules.check.AgendaNotificationSession | an AgendaNotificationSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | agendaReceiver or engineId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgendaNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaNotification()
and supportsVisibleFederation() are true | |
Method | getAgendaEngineSession | ||
Description |
Gets the | ||
Return | osid.rules.check.AgendaEngineSession | an AgendaEngineSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgendaEngine() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaEngine() is
true. | |
Method | getAgendaEngineAssignmentSession | ||
Description |
Gets the | ||
Return | osid.rules.check.AgendaEngineAssignmentSession | an AgendaEngineAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsAgendaEngineAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaEngineAssignment()
is true. | |
Method | getAgendaSmartEngineSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.AgendaSmartEngineSession | an AgendaSmartEngineSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAgendaSmartEngine() is false | ||
Compliance | optional | This method must be implemented if supportsAgendaSmartEngine()
is true. | |
Method | getInstructionLookupSession | ||
Description |
Gets the | ||
Return | osid.rules.check.InstructionLookupSession | an InstructionLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInstructionLookup() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionLookup()
is true. | |
Method | getInstructionLookupSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the engine |
Return | osid.rules.check.InstructionLookupSession | an InstructionLookupSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstructionLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionLookup()
and supportsVisibleFederation() are true | |
Method | getInstructionQuerySession | ||
Description |
Gets the | ||
Return | osid.rules.check.InstructionQuerySession | an InstructionQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInstructionQuery() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionQuery()
is true. | |
Method | getInstructionQuerySessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.InstructionQuerySession | an InstructionQuerySession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstructionQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionQuery()
and supportsVisibleFederation() are true | |
Method | getInstructionSearchSession | ||
Description |
Gets the | ||
Return | osid.rules.check.InstructionSearchSession | an InstructionSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInstructionSearch() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionSearch()
is true. | |
Method | getInstructionSearchSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.InstructionSearchSession | an InstructionSearchSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstructionSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionSearch()
and supportsVisibleFederation() are true | |
Method | getInstructionAdminSession | ||
Description |
Gets the | ||
Return | osid.rules.check.InstructionAdminSession | an InstructionAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInstructionAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionAdmin()
is true. | |
Method | getInstructionAdminSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.InstructionAdminSession | an InstructionAdminSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstructionAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionAdmin()
and supportsVisibleFederation() are true | |
Method | getInstructionNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.rules.check.InstructionReceiver | instructionReceiver | the notification callback |
Return | osid.rules.check.InstructionNotificationSession | an InstructionNotificationSession | |
Errors | NULL_ARGUMENT | instructionReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstructionNotification() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionNotification()
is true. | |
Method | getInstructionNotificationSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.rules.check.InstructionReceiver | instructionReceiver | the notification callback |
osid.id.Id | engineId | the Id of the Engine | |
Return | osid.rules.check.InstructionNotificationSession | an InstructionNotificationSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | instructionReceiver or engineId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstructionNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionNotification()
and supportsVisibleFederation() are true | |
Method | getInstructionEngineSession | ||
Description |
Gets the | ||
Return | osid.rules.check.InstructionEngineSession | an InstructionEngineSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInstructionEngine() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionEngine()
is true. | |
Method | getInstructionEngineAssignmentSession | ||
Description |
Gets the | ||
Return | osid.rules.check.InstructionEngineAssignmentSession | an InstructionEngineAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInstructionEngineAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsInstructionEngineAssignment() is true. | |
Method | getInstructionSmartEngineSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.InstructionSmartEngineSession | an InstructionSmartEngineSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstructionSmartEngine() is false | ||
Compliance | optional | This method must be implemented if supportsInstructionSmartEngine()
is true. | |
Method | getCheckLookupSession | ||
Description |
Gets the | ||
Return | osid.rules.check.CheckLookupSession | a CheckLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCheckLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCheckLookup() is
true. | |
Method | getCheckLookupSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.CheckLookupSession | a CheckLookupSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCheckLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCheckLookup() and
supportsVisibleFederation() are true | |
Method | getCheckQuerySession | ||
Description |
Gets the | ||
Return | osid.rules.check.CheckQuerySession | a CheckQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCheckQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCheckQuery() is
true. | |
Method | getCheckQuerySessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.CheckQuerySession | a CCheckQuerySession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCheckQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCheckQuery() and
supportsVisibleFederation() are true | |
Method | getCheckSearchSession | ||
Description |
Gets the | ||
Return | osid.rules.check.CheckSearchSession | a CheckSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCheckSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCheckSearch() is
true. | |
Method | getCheckSearchSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.CheckSearchSession | a CheckSearchSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCheckSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCheckSearch() and
supportsVisibleFederation() are true | |
Method | getCheckAdminSession | ||
Description |
Gets the | ||
Return | osid.rules.check.CheckAdminSession | a CheckAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCheckAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCheckAdmin() is
true. | |
Method | getCheckAdminSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.CheckAdminSession | a CheckAdminSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCheckAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCheckAdmin() and
supportsVisibleFederation() are true | |
Method | getCheckNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.rules.check.CheckReceiver | checkReceiver | the notification callback |
Return | osid.rules.check.CheckNotificationSession | a CheckNotificationSession | |
Errors | NULL_ARGUMENT | checkReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCheckNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCheckNotification()
is true. | |
Method | getCheckNotificationSessionForEngine | ||
Description |
Gets the | ||
Parameters | osid.rules.check.CheckReceiver | checkReceiver | the notification callback |
osid.id.Id | engineId | the Id of the Engine | |
Return | osid.rules.check.CheckNotificationSession | a CheckNotificationSession | |
Errors | NOT_FOUND | no engine found by the given Id | |
NULL_ARGUMENT | checkReceiver or engineId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCheckNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCheckNotification()
and supportsVisibleFederation() are true | |
Method | getCheckEngineSession | ||
Description |
Gets the | ||
Return | osid.rules.check.CheckEngineSession | a CheckEngineSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCheckEngine() is false | ||
Compliance | optional | This method must be implemented if supportsCheckEngine() is
true. | |
Method | getCheckEngineAssignmentSession | ||
Description |
Gets the | ||
Return | osid.rules.check.CheckEngineAssignmentSession | a CheckEngineAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCheckEngineAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsCheckEngineAssignment()
is true. | |
Method | getCheckSmartEngineSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.check.CheckSmartEngineSession | a CheckSmartEngineSession | |
Errors | NOT_FOUND | no Engine found by the given Id | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCheckSmartEngine() is false | ||
Compliance | optional | This method must be implemented if supportsCheckSmartEngine()
is true. |