org.osid.resource

Interface BinNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BinNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Bin 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBinNotifications() Tests if this user can register for Bin notifications.
void	registerForChangedBin(Id binId) Registers for notification of an updated bin.
void	registerForChangedBins() Registers for notification of updated bins.
void	registerForDeletedBin(Id binId) Registers for notification of a deleted bin.
void	registerForDeletedBinAncestors(Id binId) Registers for notification if an ancestor is removed from the specified bin in the bin hierarchy.
void	registerForDeletedBinDescendants(Id binId) Registers for notification if a descendant is removed from fthe specified bin in the bin hierarchy.
void	registerForDeletedBins() Registers for notification of deleted bins.
void	registerForNewBinAncestors(Id binId) Registers for notification if an ancestor is added to the specified bin in the bin hierarchy.
void	registerForNewBinDescendants(Id binId) Registers for notification if a descendant is added to the specified bin in the bin hierarchy.
void	registerForNewBins() Register for notifications of new bins.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canRegisterForBinNotifications

boolean canRegisterForBinNotifications()

Tests if this user can register for Bin 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

registerForNewBins

void registerForNewBins()
                        throws OperationFailedException,
                               PermissionDeniedException

Register for notifications of new bins. BinReceiver.newBins() is invoked when a new Bin is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBinAncestors

void registerForNewBinAncestors(Id binId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification if an ancestor is added to the specified bin in the bin hierarchy. BinReceiver.newBinAncestor() is invoked when the specified bin experiences an addition in ancestry.

Parameters:

binId - the Id of the bin to monitor

Throws:

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBinDescendants

void registerForNewBinDescendants(Id binId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification if a descendant is added to the specified bin in the bin hierarchy. BinReceiver.newBinDescendant() is invoked when the specified bin experiences an addition in descendants.

Parameters:

binId - the Id of the bin to monitor

Throws:

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBins

void registerForChangedBins()
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of updated bins. BinReceiver.changedBins() is invoked when a bin is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBin

void registerForChangedBin(Id binId)
                           throws OperationFailedException,
                                  PermissionDeniedException

Registers for notification of an updated bin. BinReceiver.changedBins() is invoked when the specified bin is changed.

Parameters:

binId - the Id of the Bin to monitor

Throws:

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBins

void registerForDeletedBins()
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of deleted bins. BinReceiver.deletedBins() is invoked when a bin is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBin

void registerForDeletedBin(Id binId)
                           throws OperationFailedException,
                                  PermissionDeniedException

Registers for notification of a deleted bin. BinReceiver.deletedBins() is invoked when the specified bin is deleted.

Parameters:

binId - the Id of the Bin to monitor

Throws:

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBinAncestors

void registerForDeletedBinAncestors(Id binId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification if an ancestor is removed from the specified bin in the bin hierarchy. BinReceiver.deletedBinAncestor() is invoked when the specified bin experiences a removal of an ancestor.

Parameters:

binId - the Id of the bin to monitor

Throws:

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBinDescendants

void registerForDeletedBinDescendants(Id binId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified bin in the bin hierarchy. BinReceiver.deletedBinDescendnant() is invoked when the specified bin experiences a removal of one of its descdendents.

Parameters:

binId - the Id of the bin to monitor

Throws:

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.