org.osid.tracking

Interface FrontOfficeNotificationSession

All Superinterfaces:

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

public interface FrontOfficeNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to FrontOffice 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	canRegisterForFrontOfficeNotifications() Tests if this user can register for FrontOffice notifications.
void	registerForChangedFrontOffice(Id frontOfficeId) Registers for notification of an updated front office.
void	registerForChangedFrontOffices() Registers for notification of updated frontOffices.
void	registerForDeletedFrontOffice(Id frontOfficeId) Registers for notification of a deleted front office.
void	registerForDeletedFrontOfficeAncestors(Id frontOfficeId) Registers for notification if an ancestor is removed from the specified front office in the front office hierarchy.
void	registerForDeletedFrontOfficeDescendants(Id frontOfficeId) Registers for notification if a descendant is removed from fthe specified front office in the front office hierarchy.
void	registerForDeletedFrontOffices() Registers for notification of deleted frontOffices.
void	registerForNewFrontOfficeAncestors(Id frontOfficeId) Registers for notification if an ancestor is added to the specified front office in the front office hierarchy.
void	registerForNewFrontOfficeDescendants(Id frontOfficeId) Registers for notification if a descendant is added to the specified front office in the front office hierarchy.
void	registerForNewFrontOffices() Register for notifications of new frontOffices.

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

canRegisterForFrontOfficeNotifications

boolean canRegisterForFrontOfficeNotifications()

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

registerForNewFrontOffices

void registerForNewFrontOffices()
                                throws OperationFailedException,
                                       PermissionDeniedException

Register for notifications of new frontOffices. FrontOfficeReceiver.newFrontOffices() is invoked when a new FrontOffice is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewFrontOfficeAncestors

void registerForNewFrontOfficeAncestors(Id frontOfficeId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification if an ancestor is added to the specified front office in the front office hierarchy. FrontOfficeReceiver.newFrontOfficeAncestor() is invoked when the specified front office experiences an addition in ancestry.

Parameters:

frontOfficeId - the Id of the front office to monitor

Throws:

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewFrontOfficeDescendants

void registerForNewFrontOfficeDescendants(Id frontOfficeId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification if a descendant is added to the specified front office in the front office hierarchy. FrontOfficeReceiver.newFrontOfficeDescendant() is invoked when the specified front office experiences an addition in descendants.

Parameters:

frontOfficeId - the Id of the front office to monitor

Throws:

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedFrontOffices

void registerForChangedFrontOffices()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of updated frontOffices. FrontOfficeReceiver.changedFrontOffices() is invoked when a front office is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedFrontOffice

void registerForChangedFrontOffice(Id frontOfficeId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of an updated front office. FrontOfficeReceiver.changedFrontOffices() is invoked when the specified front office is changed.

Parameters:

frontOfficeId - the Id of the FrontOffice to monitor

Throws:

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFrontOffices

void registerForDeletedFrontOffices()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of deleted frontOffices. FrontOfficeReceiver.deletedFrontOffices() is invoked when a front office is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFrontOffice

void registerForDeletedFrontOffice(Id frontOfficeId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of a deleted front office. FrontOfficeReceiver.deletedFrontOffices() is invoked when the specified front office is deleted.

Parameters:

frontOfficeId - the Id of the FrontOffice to monitor

Throws:

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFrontOfficeAncestors

void registerForDeletedFrontOfficeAncestors(Id frontOfficeId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification if an ancestor is removed from the specified front office in the front office hierarchy. FrontOfficeReceiver.deletedFrontOfficeAncestor() is invoked when the specified front office experiences a removal of an ancestor.

Parameters:

frontOfficeId - the Id of the front office to monitor

Throws:

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedFrontOfficeDescendants

void registerForDeletedFrontOfficeDescendants(Id frontOfficeId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified front office in the front office hierarchy. FrontOfficeReceiver.deletedFrontOfficeDescednant() is invoked when the specified front office experiences a removal of one of its descdendents.

Parameters:

frontOfficeId - the Id of the front office to monitor

Throws:

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.