public interface FamilyNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Family
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 Family
object itself. Adding and removing relationships result in notifications
available from the notification session for rules.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForFamilyNotifications()
Tests if this user can register for
Family
notifications. |
void |
registerForChangedFamilies()
Registers for notification of updated families.
|
void |
registerForChangedFamily(Id familyId)
Registers for notification of an updated family.
|
void |
registerForDeletedFamilies()
Registers for notification of deleted families.
|
void |
registerForDeletedFamily(Id familyId)
Registers for notification of a deleted family.
|
void |
registerForDeletedFamilyAncestors(Id familyId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified family.
|
void |
registerForDeletedFamilyDescendants(Id familyId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified family.
|
void |
registerForNewFamilies()
Register for notifications of new families.
|
void |
registerForNewFamilyAncestors(Id familyId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified family.
|
void |
registerForNewFamilyDescendants(Id familyId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified family.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForFamilyNotifications()
Family
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 registerForNewFamilies() throws OperationFailedException, PermissionDeniedException
FamilyReceiver.newFamily()
is invoked when a new Family
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewFamilyAncestors(Id familyId) throws OperationFailedException, PermissionDeniedException
FamilyReceiver.newAncestorFamily()
is invoked when the
specified family node gets a new ancestor.familyId
- the Id
of the Family
node to monitorNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewFamilyDescendants(Id familyId) throws OperationFailedException, PermissionDeniedException
FamilyReceiver.newDescendantFamily()
is invoked when the
specified family node gets a new descendant.familyId
- the Id
of the Family
node to monitorNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedFamilies() throws OperationFailedException, PermissionDeniedException
FamilyReceiver.changedFamily()
is invoked when a family is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedFamily(Id familyId) throws OperationFailedException, PermissionDeniedException
FamilyReceiver.changedFamily()
is invoked when the specified
family is changed.familyId
- the Id
of the Family
to
monitorNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFamilies() throws OperationFailedException, PermissionDeniedException
FamilyReceiver.deletedFamily()
is invoked when a family is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFamily(Id familyId) throws OperationFailedException, PermissionDeniedException
FamilyReceiver.deletedFamily()
is invoked when the specified
family is deleted.familyId
- the Id
of the Family
to
monitorNullArgumentException
- familyId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFamilyAncestors(Id familyId) throws OperationFailedException, PermissionDeniedException
FamilyReceiver.deletedAncestor()
is invoked when the specified
family node loses an ancestor.familyId
- the Id
of the Family
to
monitorNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFamilyDescendants(Id familyId) throws OperationFailedException, PermissionDeniedException
FamilyReceiver.deletedDescendant()
is invoked when the
specified family node loses a descendant.familyId
- the Id
of the Family
to
monitorNullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.