public interface CheckNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Check
objects in this Engine.
This also
includes existing checks that may appear or disappear due to changes in
the Engine
hierarchy, 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
CheckLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForCheckNotifications()
Tests if this user can register for
Check
notifications. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
void |
registerForChangedCheck(Id checkId)
Registers for notification of an updated hold.
|
void |
registerForChangedChecks()
Registers for notification of updated checks.
|
void |
registerForDeletedCheck(Id checkId)
Registers for notification of a deleted hold.
|
void |
registerForDeletedChecks()
Registers for notification of deleted checks.
|
void |
registerForNewChecks()
Register for notifications of new checks.
|
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 canRegisterForCheckNotifications()
Check
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 registerForNewChecks() throws OperationFailedException, PermissionDeniedException
CheckReceiver.newChecks()
is invoked when a new Check
appears in this engine.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedChecks() throws OperationFailedException, PermissionDeniedException
CheckReceiver.changedChecks()
is invoked when a check in this
engine is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CheckReceiver.changedChecks()
is invoked when the specified
check in this engine is changed.checkId
- the Id
of the Check
to
monitorNotFoundException
- a check was not found in this
engine identified by the given Id
NullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedChecks() throws OperationFailedException, PermissionDeniedException
CheckReceiver.deletedChecks()
is invoked when a check is
deleted or removed from this engine.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CheckReceiver.deletedChecks()
is invoked when the specified
check is deleted or removed from this engine.checkId
- the Id
of the Check
to
monitorNotFoundException
- a check was not found identified by
the given Id
NullArgumentException
- checkId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.