Interface | osid.rules.check.InstructionNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getEngineId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Engine Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngine | ||
Description |
Gets the | ||
Return | osid.rules.Engine | the engine | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForInstructionNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedEngineView | ||
Description |
Federates the view for methods in this session. A federated view will include instructions in engines which are children of this engine in the engine hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedEngineView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this engine only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewInstructions | ||
Description |
Register for notifications of new instructions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewInstructionsForAgenda | ||
Description |
Register for notifications of new instructions related
to the given agenda. | ||
Parameters | osid.id.Id | agendaId | the Id of the Agenda to monitor |
Errors | NULL_ARGUMENT | agendaId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewInstructionsForCheck | ||
Description |
Register for notifications of new instructions related
to the given agenda. | ||
Parameters | osid.id.Id | checkId | the Id of the Check to monitor |
Errors | NULL_ARGUMENT | checkId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedInstructions | ||
Description |
Registers for notification of updated instructions.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedInstructionsForAgenda | ||
Description |
Registers for notification of updated instructions
related to the given agenda. | ||
Parameters | osid.id.Id | agendaId | the Id of the Agenda to monitor |
Errors | NULL_ARGUMENT | agendaId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedInstructionsForCheck | ||
Description |
Registers for notification of updated instructions
related to the given check. | ||
Parameters | osid.id.Id | checkId | the Id of the Check to monitor |
Errors | NULL_ARGUMENT | checkId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedInstruction | ||
Description |
Registers for notification of an updated instruction.
| ||
Parameters | osid.id.Id | instructionId | the Id of the Instruction to monitor |
Errors | NOT_FOUND | an instruction was not found in this engine identified by the given
Id | |
NULL_ARGUMENT | instructionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInstructions | ||
Description |
Registers for notification of deleted instructions.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInstructionsForAgenda | ||
Description |
Registers for notification of deleted instruction for
an agenda. | ||
Parameters | osid.id.Id | agendaId | the Id of the Agenda to monitor |
Errors | NULL_ARGUMENT | agendaId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInstructionsForCheck | ||
Description |
Registers for notification of deleted instruction for a
check. | ||
Parameters | osid.id.Id | checkId | the Id of the Check to monitor |
Errors | NULL_ARGUMENT | checkId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedInstruction | ||
Description |
Registers for notification of a deleted instruction.
| ||
Parameters | osid.id.Id | instructionId | the Id of the Instruction to monitor |
Errors | NOT_FOUND | an instruction was not found identified by the given Id | |
NULL_ARGUMENT | instructionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |