org.osid.workflow

Interface OfficeNotificationSession

All Superinterfaces:

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

public interface OfficeNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Office 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	canRegisterForOfficeNotifications() Tests if this user can register for Office notifications.
void	registerForChangedOffice(Id officeId) Registers for notification of an updated office.
void	registerForChangedOffices() Registers for notification of updated offices.
void	registerForDeletedOffice(Id officeId) Registers for notification of a deleted office.
void	registerForDeletedOfficeAncestors(Id officeId) Registers for notification if an ancestor is removed from the specified office in the office hierarchy.
void	registerForDeletedOfficeDescendants(Id officeId) Registers for notification if a descendant is removed from fthe specified office in the office hierarchy.
void	registerForDeletedOffices() Registers for notification of deleted offices.
void	registerForNewOfficeAncestors(Id officeId) Registers for notification if an ancestor is added to the specified office in the office hierarchy.
void	registerForNewOfficeDescendants(Id officeId) Registers for notification if a descendant is added to the specified office in the office hierarchy.
void	registerForNewOffices() Register for notifications of new offices.

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

canRegisterForOfficeNotifications

boolean canRegisterForOfficeNotifications()

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

registerForNewOffices

void registerForNewOffices()
                           throws OperationFailedException,
                                  PermissionDeniedException

Register for notifications of new offices. OfficeReceiver.newOffices() is invoked when a new Office is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOfficeAncestors

void registerForNewOfficeAncestors(Id officeId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

officeId - the Id of the office to monitor

Throws:

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewOfficeDescendants

void registerForNewOfficeDescendants(Id officeId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

officeId - the Id of the office to monitor

Throws:

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOffices

void registerForChangedOffices()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of updated offices. OfficeReceiver.changedOffices() is invoked when an office is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedOffice

void registerForChangedOffice(Id officeId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of an updated office. OfficeReceiver.changedOffices() is invoked when the specified office is changed.

Parameters:

officeId - the Id of the Office to monitor

Throws:

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOffices

void registerForDeletedOffices()
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of deleted offices. OfficeReceiver.deletedOffices() is invoked when an office is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOffice

void registerForDeletedOffice(Id officeId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Registers for notification of a deleted office. OfficeReceiver.deletedOffices() is invoked when the specified office is deleted.

Parameters:

officeId - the Id of the Office to monitor

Throws:

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOfficeAncestors

void registerForDeletedOfficeAncestors(Id officeId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

officeId - the Id of the office to monitor

Throws:

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedOfficeDescendants

void registerForDeletedOfficeDescendants(Id officeId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

officeId - the Id of the office to monitor

Throws:

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.