org.osid.workflow

Interface StepNotificationSession

All Superinterfaces:

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

public interface StepNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Step objects in this Office. This also includes existing steps 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 StepLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForStepNotifications() Tests if this user can register for Step notifications.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
void	registerForChangedStep(Id stepId) Registers for notification of an updated step.
void	registerForChangedSteps() Registers for notification of updated steps.
void	registerForChangedStepsForProcess(Id processId) Register for notifications of updated steps for the given process Id.
void	registerForDeletedStep(Id stepId) Registers for notification of a deleted step.
void	registerForDeletedSteps() Registers for notification of deleted steps.
void	registerForDeletedStepsForProcess(Id processId) Register for notifications of deleted steps for the given process Id.
void	registerForNewSteps() Register for notifications of new steps.
void	registerForNewStepsForProcess(Id processId) Register for notifications of new steps in the given process Id.
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.

canRegisterForStepNotifications

boolean canRegisterForStepNotifications()

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

registerForNewSteps

void registerForNewSteps()
                         throws OperationFailedException,
                                PermissionDeniedException

Register for notifications of new steps. StepReceiver.newSteps() is invoked when a new Step appears in this office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewStepsForProcess

void registerForNewStepsForProcess(Id processId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Register for notifications of new steps in the given process Id. StepReceiver.newSteps() is invoked when a new Step is created.

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.

registerForChangedSteps

void registerForChangedSteps()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of updated steps. StepReceiver.changedSteps() is invoked when a step in this office is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedStepsForProcess

void registerForChangedStepsForProcess(Id processId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Register for notifications of updated steps for the given process Id. StepReceiver.changedSteps() is invoked when a step in this office is changed.

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.

registerForChangedStep

void registerForChangedStep(Id stepId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of an updated step. StepReceiver.changedSteps() is invoked when the specified step in this office is changed.

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.

registerForDeletedSteps

void registerForDeletedSteps()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of deleted steps. StepReceiver.deletedSteps() is invoked when a step is deleted or removed from this office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedStepsForProcess

void registerForDeletedStepsForProcess(Id processId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Register for notifications of deleted steps for the given process Id. StepReceiver.deletedSteps() is invoked when a step in this office is removed or deleted.

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.

registerForDeletedStep

void registerForDeletedStep(Id stepId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of a deleted step. StepReceiver.deletedSteps() is invoked when the specified step is deleted or removed from this office.

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.