org.osid.workflow

Interface WorkNotificationSession

All Superinterfaces:

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

public interface WorkNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForWorkNotifications() Tests if this user can register for Work notifications.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
void	registerForChangedWork(Id workId) Registers for notification of an updated work.
void	registerForChangedWorks() Registers for notification of updated works.
void	registerForDeletedWork(Id workId) Registers for notification of a deleted work.
void	registerForDeletedWorks() Registers for notification of deleted works.
void	registerForNewWorks() Register for notifications of new works.
void	useFederatedOfficeView() Federates the view for methods in this session.
void	useIsolatedOfficeView() 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

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForWorkNotifications

boolean canRegisterForWorkNotifications()

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

useFederatedOfficeView

void useFederatedOfficeView()

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

Compliance:

mandatory - This method is must be implemented.

useIsolatedOfficeView

void useIsolatedOfficeView()

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

Compliance:

mandatory - This method is must be implemented.

registerForNewWorks

void registerForNewWorks()
                         throws OperationFailedException,
                                PermissionDeniedException

Register for notifications of new works. WorkReceiver.newWorks() is invoked when a new Work appears in this office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedWorks

void registerForChangedWorks()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of updated works. WorkReceiver.changedWorks() is invoked when a work in this office is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedWork

void registerForChangedWork(Id workId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of an updated work. WorkReceiver.changedWorks() is invoked when the specified work in this office is changed.

Parameters:

workId - the Id of the Work to monitor

Throws:

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedWorks

void registerForDeletedWorks()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of deleted works. WorkReceiver.deletedWorks() is invoked when a work is deleted or removed from this office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedWork

void registerForDeletedWork(Id workId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of a deleted work. WorkReceiver.deletedWorks() is invoked when the specified work is deleted or removed from this office.

Parameters:

workId - the Id of the Work to monitor

Throws:

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.