public interface GroupNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Resource
members. 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 |
canRegisterForGroupNotifications()
Tests if this user can register for group notifications.
|
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
void |
registerForDeletedMembers(Id resourceId)
Register for notifications of deleted resource memberss.
|
void |
registerForNewMembers(Id resourceId)
Register for notifications of new resource memberss.
|
void |
useFederatedBinView()
Federates the view for methods in this session.
|
void |
useIsolatedBinView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBinId()
Bin
Id
associated with this
session. Bin Id
associated with this sessionmandatory
- This method must be implemented. Bin getBin() throws OperationFailedException, PermissionDeniedException
Bin
associated with this session. Bin
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForGroupNotifications()
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 useFederatedBinView()
mandatory
- This method is must be implemented. void useIsolatedBinView()
mandatory
- This method is must be implemented. void registerForNewMembers(Id resourceId) throws OperationFailedException, PermissionDeniedException
GroupReceiver.newMember()
is invoked when a new member is
added to the specified group.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMembers(Id resourceId) throws OperationFailedException, PermissionDeniedException
GroupReceiver.deletedMember()
is invoked when a new member is
removed from the specified group.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.