org.osid.hold

Interface BlockNotificationSession

All Superinterfaces:

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

public interface BlockNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Block objects in this Oubliette. This also includes existing blocks that may appear or disappear due to changes in the Oubliette hierarchy, 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.

The two views defined in this session correspond to the views in the BlockLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeBlockNotification(Id notificationId) Acknowledge a block notification.
boolean	canRegisterForBlockNotifications() Tests if this user can register for Block notifications.
Oubliette	getOubliette() Gets the Oubliette associated with this session.
Id	getOublietteId() Gets the Oubliette Id associated with this session.
void	registerForChangedBlock(Id blockId) Registers for notification of an updated block.
void	registerForChangedBlocks() Registers for notification of updated blocks.
void	registerForDeletedBlock(Id blockId) Registers for notification of a deleted block.
void	registerForDeletedBlocks() Registers for notification of deleted blocks.
void	registerForNewBlocks() Register for notifications of new blocks.
void	reliableBlockNotifications() Reliable notifications are desired.
void	unreliableBlockNotifications() Unreliable notifications are desired.
void	useFederatedOublietteView() Federates the view for methods in this session.
void	useIsolatedOublietteView() Isolates the view for methods in this session.

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

getOublietteId

Id getOublietteId()

Gets the Oubliette Id associated with this session.

Returns:

the Oubliette Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOubliette

Oubliette getOubliette()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Oubliette associated with this session.

Returns:

the oubliette

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForBlockNotifications

boolean canRegisterForBlockNotifications()

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

useFederatedOublietteView

void useFederatedOublietteView()

Federates the view for methods in this session. A federated view will include blocks in oubliettes which are children of this oubliette in the oubliette hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOublietteView

void useIsolatedOublietteView()

Isolates the view for methods in this session. An isolated view restricts notifications to this oubliette only.

Compliance:

mandatory - This method is must be implemented.

reliableBlockNotifications

void reliableBlockNotifications()

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeBlockNotification() .

Compliance:

mandatory - This method is must be implemented.

unreliableBlockNotifications

void unreliableBlockNotifications()

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliance:

mandatory - This method is must be implemented.

acknowledgeBlockNotification

void acknowledgeBlockNotification(Id notificationId)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Acknowledge a block notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBlocks

void registerForNewBlocks()
                          throws OperationFailedException,
                                 PermissionDeniedException

Register for notifications of new blocks. BlockReceiver.newBlocks() is invoked when a new Block appears in this oubliette.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBlocks

void registerForChangedBlocks()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of updated blocks. BlockReceiver.changedBlocks() is invoked when a block in this oubliette is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBlock

void registerForChangedBlock(Id blockId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Registers for notification of an updated block. BlockReceiver.changedBlocks() is invoked when the specified block in this oubliette is changed.

Parameters:

blockId - the Id of the Block to monitor

Throws:

NotFoundException - a block was not found in this oubliette identified by the given Id

NullArgumentException - blockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBlocks

void registerForDeletedBlocks()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of deleted blocks. BlockReceiver.deletedBlocks() is invoked when a block is deleted or removed from this oubliette.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBlock

void registerForDeletedBlock(Id blockId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Registers for notification of a deleted block. BlockReceiver.deletedBlocks() is invoked when the specified block is deleted or removed from this oubliette.

Parameters:

blockId - the Id of the Block to monitor

Throws:

NotFoundException - a block was not found identified by the given Id

NullArgumentException - blockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.