OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.InstructionNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Instruction objects in this Engine. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the InstructionLookupSession.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForInstructionNotifications
Description

Tests if this user can register for Instruction notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedEngineView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedEngineView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this engine only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewInstructions
Description

Register for notifications of new instructions. InstructionReceiver.newInstructions() is invoked when a new Instruction appears in this engine.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewInstructionsForAgenda
Description

Register for notifications of new instructions related to the given agenda. InstructionReceiver.newInstructions() is invoked when a new Instruction appears in this engine.

Parametersosid.id.IdagendaIdthe Id of the Agenda to monitor
ErrorsNULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewInstructionsForCheck
Description

Register for notifications of new instructions related to the given agenda. InstructionReceiver.newInstructions() is invoked when a new Instruction appears in this engine.

Parametersosid.id.IdcheckIdthe Id of the Check to monitor
ErrorsNULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedInstructions
Description

Registers for notification of updated instructions. InstructionReceiver.changedInstructions() is invoked when an instruction in this engine is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedInstructionsForAgenda
Description

Registers for notification of updated instructions related to the given agenda. InstructionReceiver.changedInstructions() is invoked when an instruction related to the agenda in this engine is changed.

Parametersosid.id.IdagendaIdthe Id of the Agenda to monitor
ErrorsNULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedInstructionsForCheck
Description

Registers for notification of updated instructions related to the given check. InstructionReceiver.changedInstructions() is invoked when an instruction related to the check in this engine is changed.

Parametersosid.id.IdcheckIdthe Id of the Check to monitor
ErrorsNULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedInstruction
Description

Registers for notification of an updated instruction. InstructionReceiver.changedInstructions() is invoked when the specified instruction in this engine is changed.

Parametersosid.id.IdinstructionIdthe Id of the Instruction to monitor
ErrorsNOT_FOUNDan instruction was not found in this engine identified by the given Id
NULL_ARGUMENT instructionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedInstructions
Description

Registers for notification of deleted instructions. InstructionReceiver.deletedInstructions() is invoked when an instruction is deleted or removed from this engine.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedInstructionsForAgenda
Description

Registers for notification of deleted instruction for an agenda. InstructionReceiver.deletedInstructions() is invoked when the related instruction is deleted or removed from this engine.

Parametersosid.id.IdagendaIdthe Id of the Agenda to monitor
ErrorsNULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedInstructionsForCheck
Description

Registers for notification of deleted instruction for a check. InstructionReceiver.deletedInstructions() is invoked when the related instruction is deleted or removed from this engine.

Parametersosid.id.IdcheckIdthe Id of the Check to monitor
ErrorsNULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedInstruction
Description

Registers for notification of a deleted instruction. InstructionReceiver.deletedInstructions() is invoked when the specified instruction is deleted or removed from this engine.

Parametersosid.id.IdinstructionIdthe Id of the Instruction to monitor
ErrorsNOT_FOUNDan instruction was not found identified by the given Id
NULL_ARGUMENT instructionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.