public interface ProcedureNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Procedure
objects. 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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForProcedureNotifications()
Tests if this user can register for
Procedure
notifications. |
Cookbook |
getCookbook()
Gets the
Cookbook associated with this session. |
Id |
getCookbookId()
Gets the
Cookbook Id associated with
this session. |
void |
registerForChangedProcedure(Id procedureId)
Registers for notification of an updated procedure.
|
void |
registerForChangedProcedures()
Registers for notification of updated procedures.
|
void |
registerForDeletedProcedure(Id procedureId)
Registers for notification of a deleted procedure.
|
void |
registerForDeletedProcedures()
Registers for notification of deleted procedures.
|
void |
registerForNewProcedures()
Register for notifications of new procedures.
|
void |
useFederatedCookbookView()
Federates the view for methods in this session.
|
void |
useIsolatedCookbookView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCookbookId()
Cookbook
Id
associated with
this session. Cookbook Id
associated with this sessionmandatory
- This method must be implemented. Cookbook getCookbook() throws OperationFailedException, PermissionDeniedException
Cookbook
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForProcedureNotifications()
Procedure
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 useFederatedCookbookView()
mandatory
- This method is must be implemented. void useIsolatedCookbookView()
mandatory
- This method is must be implemented. void registerForNewProcedures() throws OperationFailedException, PermissionDeniedException
ProcedureReceiver.newProcedures()
is invoked when a new
Procedure
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcedures() throws OperationFailedException, PermissionDeniedException
ProcedureReceiver.changedProcedures()
is invoked when a
procedure is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcedure(Id procedureId) throws OperationFailedException, PermissionDeniedException
ProcedureReceiver.changedProcedures()
is invoked when the
specified procedure is changed.procedureId
- the Id
of the Procedure
to monitorNullArgumentException
- procedureId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProcedures() throws OperationFailedException, PermissionDeniedException
ProcedureReceiver.deletedProcedures()
is invoked when a
procedure is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProcedure(Id procedureId) throws OperationFailedException, PermissionDeniedException
ProcedureReceiver.deletedProcedures()
is invoked when the
specified procedure is deleted.procedureId
- the Id
of the Procedure
to monitorNullArgumentException
- procedureId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.