public interface InstructionNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForInstructionNotifications()
Tests if this user can register for
Instruction
notifications. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
void |
registerForChangedInstruction(Id instructionId)
Registers for notification of an updated instruction.
|
void |
registerForChangedInstructions()
Registers for notification of updated instructions.
|
void |
registerForChangedInstructionsForAgenda(Id agendaId)
Registers for notification of updated instructions related to the
given agenda.
|
void |
registerForChangedInstructionsForCheck(Id checkId)
Registers for notification of updated instructions related to the
given check.
|
void |
registerForDeletedInstruction(Id instructionId)
Registers for notification of a deleted instruction.
|
void |
registerForDeletedInstructions()
Registers for notification of deleted instructions.
|
void |
registerForDeletedInstructionsForAgenda(Id agendaId)
Registers for notification of deleted instruction for an agenda.
|
void |
registerForDeletedInstructionsForCheck(Id checkId)
Registers for notification of deleted instruction for a check.
|
void |
registerForNewInstructions()
Register for notifications of new instructions.
|
void |
registerForNewInstructionsForAgenda(Id agendaId)
Register for notifications of new instructions related to the given
agenda.
|
void |
registerForNewInstructionsForCheck(Id checkId)
Register for notifications of new instructions related to the given
agenda.
|
void |
useFederatedEngineView()
Federates the view for methods in this session.
|
void |
useIsolatedEngineView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForInstructionNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedEngineView()
mandatory
- This method is must be implemented. void useIsolatedEngineView()
mandatory
- This method is must be implemented. void registerForNewInstructions() throws OperationFailedException, PermissionDeniedException
InstructionReceiver.newInstructions()
is invoked when a new
Instruction
appears in this engine.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewInstructionsForAgenda(Id agendaId) throws OperationFailedException, PermissionDeniedException
InstructionReceiver.newInstructions()
is
invoked when a new Instruction
appears in this engine.agendaId
- the Id
of the Agenda
to
monitorNullArgumentException
- agendaId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewInstructionsForCheck(Id checkId) throws OperationFailedException, PermissionDeniedException
InstructionReceiver.newInstructions()
is
invoked when a new Instruction
appears in this engine.checkId
- the Id
of the Check
to
monitorNullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInstructions() throws OperationFailedException, PermissionDeniedException
InstructionReceiver.changedInstructions()
is invoked when an
instruction in this engine is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInstructionsForAgenda(Id agendaId) throws OperationFailedException, PermissionDeniedException
InstructionReceiver.changedInstructions()
is invoked when an instruction related to the agenda in this engine is
changed.agendaId
- the Id
of the Agenda
to
monitorNullArgumentException
- agendaId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInstructionsForCheck(Id checkId) throws OperationFailedException, PermissionDeniedException
InstructionReceiver.changedInstructions()
is invoked when an instruction related to the check in this engine is
changed.checkId
- the Id
of the Check
to
monitorNullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInstruction(Id instructionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InstructionReceiver.changedInstructions()
is invoked when the
specified instruction in this engine is changed.instructionId
- the Id
of the Instruction
to monitorNotFoundException
- an instruction was not found in
this engine identified by the given Id
NullArgumentException
- instructionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInstructions() throws OperationFailedException, PermissionDeniedException
InstructionReceiver.deletedInstructions()
is invoked when an
instruction is deleted or removed from this engine.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInstructionsForAgenda(Id agendaId) throws OperationFailedException, PermissionDeniedException
InstructionReceiver.deletedInstructions()
is invoked
when the related instruction is deleted or removed from this engine.agendaId
- the Id
of the Agenda
to
monitorNullArgumentException
- agendaId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInstructionsForCheck(Id checkId) throws OperationFailedException, PermissionDeniedException
InstructionReceiver.deletedInstructions()
is invoked when the
related instruction is deleted or removed from this engine.checkId
- the Id
of the Check
to
monitorNullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInstruction(Id instructionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InstructionReceiver.deletedInstructions()
is invoked when the
specified instruction is deleted or removed from this engine.instructionId
- the Id
of the Instruction
to monitorNotFoundException
- an instruction was not found
identified by the given Id
NullArgumentException
- instructionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.