public interface CookbookNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Cookbook
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.
Notifications are triggered with changes to the Cookbook
object itself. Adding and removing procedures result in
notifications available from the notification session for procedures.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForCookbookNotifications()
Tests if this user can register for
Cookbook
notifications. |
void |
registerForChangedCookbook(Id cookbookId)
Registers for notification of an updated cookbook.
|
void |
registerForChangedCookbooks()
Registers for notification of updated cook books.
|
void |
registerForDeletedCookbook(Id cookbookId)
Registers for notification of a deleted cookbook.
|
void |
registerForDeletedCookbookAncestors(Id cookbookId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified cook book
CookbookReceiver.deletedAncestor() is invoked when the
specified cook book node loses an ancestor. |
void |
registerForDeletedCookbookDescendants(Id cookbookId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified cookbook.
|
void |
registerForDeletedCookbooks()
Registers for notification of deleted cook books.
|
void |
registerForNewCookbookAncestors(Id cookbookId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified cookbook.
|
void |
registerForNewCookbookDescendants(Id cookbookId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified cookbook.
|
void |
registerForNewCookbooks()
Register for notifications of new cook books.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForCookbookNotifications()
Cookbook
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 registerForNewCookbooks() throws OperationFailedException, PermissionDeniedException
CookbookReceiver.newCookbooks()
is invoked when a new
Cookbook
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCookbookAncestors(Id cookbookId) throws OperationFailedException, PermissionDeniedException
CookbookReceiver.newAncestorCookbook()
is invoked when the
specified cook book node gets a new ancestor.cookbookId
- the Id
of the Cookbook
node to monitorNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCookbookDescendants(Id cookbookId) throws OperationFailedException, PermissionDeniedException
CookbookReceiver.newDescendantCookbook()
is invoked when the
specified cook book node gets a new descendant.cookbookId
- the Id
of the Cookbook
node to monitorNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCookbooks() throws OperationFailedException, PermissionDeniedException
CookbookReceiver.changedCookbook()
is invoked when a cook book
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCookbook(Id cookbookId) throws OperationFailedException, PermissionDeniedException
CookbookReceiver.changedCookbooks()
is invoked when the
specified cook book is changed.cookbookId
- the Id
of the Cookbook
to monitorNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCookbooks() throws OperationFailedException, PermissionDeniedException
CookbookReceiver.deletedCookbooks()
is invoked when a cook
book is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCookbook(Id cookbookId) throws OperationFailedException, PermissionDeniedException
CookbookReceiver.deletedCookbooks()
is invoked when the
specified cook book is deleted.cookbookId
- the Id
of the Cookbook
to monitorNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCookbookAncestors(Id cookbookId) throws OperationFailedException, PermissionDeniedException
CookbookReceiver.deletedAncestor()
is invoked when the
specified cook book node loses an ancestor.cookbookId
- the Id
of the Cookbook
to monitorNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCookbookDescendants(Id cookbookId) throws OperationFailedException, PermissionDeniedException
CookbookReceiver.deletedDescendant()
is invoked when the
specified cook book node loses a descendant.cookbookId
- the Id
of the Cookbook
to monitorNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.