org.osid.tracking

Interface QueueNotificationSession

All Superinterfaces:

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

public interface QueueNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Queue objects in this FrontOffice. This also includes existing queues that may appear or disappear due to changes in the FrontOffice 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 QueueLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForQueueNotifications() Tests if this user can register for Queue notifications.
FrontOffice	getFrontOffice() Gets the FrontOffice associated with this session.
Id	getFrontOfficeId() Gets the FrontOffice Id associated with this session.
void	registerForChangedQueue(Id queueId) Registers for notification of an updated queue.
void	registerForChangedQueues() Registers for notification of updated queues.
void	registerForDeletedQueue(Id queueId) Registers for notification of a deleted queue.
void	registerForDeletedQueues() Registers for notification of deleted queues.
void	registerForNewQueues() Register for notifications of new queues.
void	useFederatedFrontOfficeView() Federates the view for methods in this session.
void	useIsolatedFrontOfficeView() 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

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the front office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForQueueNotifications

boolean canRegisterForQueueNotifications()

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

useFederatedFrontOfficeView

void useFederatedFrontOfficeView()

Federates the view for methods in this session. A federated view will include queues in front offices which are children of this front office in the front office hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFrontOfficeView

void useIsolatedFrontOfficeView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewQueues

void registerForNewQueues()
                          throws OperationFailedException,
                                 PermissionDeniedException

Register for notifications of new queues. QueueReceiver.newQueues() is invoked when a new Queue appears in this front office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedQueues

void registerForChangedQueues()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of updated queues. QueueReceiver.changedQueues() is invoked when a queue in this front office is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedQueue

void registerForChangedQueue(Id queueId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of an updated queue. QueueReceiver.changedQueues() is invoked when the specified queue in this front office is changed.

Parameters:

queueId - the Id of the Queue to monitor

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedQueues

void registerForDeletedQueues()
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of deleted queues. QueueReceiver.deletedQueues() is invoked when a queue is deleted or removed from this front office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedQueue

void registerForDeletedQueue(Id queueId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of a deleted queue. QueueReceiver.deletedQueues() is invoked when the specified queue is deleted or removed from this front office.

Parameters:

queueId - the Id of the Queue to monitor

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.