org.osid.workflow

Interface WorkflowEventNotificationSession

All Superinterfaces:

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

public interface WorkflowEventNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to WorkflowEvent objects in this Process. 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	canRegisterForWorkflowEventNotifications() Tests if this user can register for WorkflowEvent notifications.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
void	registerForNewWorkflowEvents() Register for notifications of new workflow events.
void	registerForNewWorkflowEventsForProcess(Id processId) Register for notifications of new workflow events for the given process.
void	registerForNewWorkflowEventsForStep(Id stepId) Register for notifications of new workflow events for the given step.
void	registerForNewWorkflowEventsForWork(Id workId) Register for notifications of new workflow events for the given work.
void	registerForNewWorkflowEventsForWorker(Id resourceId) Register for notifications of new workflow events for the given resource.
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.

useFederatedOfficeView

void useFederatedOfficeView()

Federates the view for methods in this session. A federated view will include events 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.

canRegisterForWorkflowEventNotifications

boolean canRegisterForWorkflowEventNotifications()

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

registerForNewWorkflowEvents

void registerForNewWorkflowEvents()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Register for notifications of new workflow events. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewWorkflowEventsForProcess

void registerForNewWorkflowEventsForProcess(Id processId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of new workflow events for the given process. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

Parameters:

processId - the Id of the Process to monitor

Throws:

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewWorkflowEventsForStep

void registerForNewWorkflowEventsForStep(Id stepId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Register for notifications of new workflow events for the given step. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

Parameters:

stepId - the Id of the Step to monitor

Throws:

NullArgumentException - stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewWorkflowEventsForWork

void registerForNewWorkflowEventsForWork(Id workId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Register for notifications of new workflow events for the given work. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

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.

registerForNewWorkflowEventsForWorker

void registerForNewWorkflowEventsForWorker(Id resourceId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Register for notifications of new workflow events for the given resource. WorkflowEventReceiver.newWorkflowEvents() is invoked when a new WorkflowEvent appears in this process.

Parameters:

resourceId - the Id of the Resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.