WorkflowEventBroker (OBE Engine Service Provider Interface)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.obe.spi.service
Interface WorkflowEventBroker

All Superinterfaces:: WorkflowService

public interface WorkflowEventBroker
extends WorkflowService

Provides access to OBE run-time events. The event object passed to a listener provides access to the entity that was the source of the event. The listener may call methods on that entity (thus potentially affecting the entity's state and causing further notifications). When running in a transactional environment (such as the J2EE server), listeners are also able to veto the transaction, by calling setRollbackOnly() on the UserTransaction object. At present, exceptions thrown by listener methods are logged and ignored; this behaviour may well change.

Author:: Adrian Price

Field Summary
`static java.lang.String`	`SERVICE_NAME`

Method Summary
`void`	`addActivityInstanceListener(ActivityInstanceListener listener, int mask)` Subscribes to activity instance events.
`void`	`addActivityInstanceListener(ApplicationEventListener listener, int mask)` Subscribes to activity instance events.
`void`	`addAttributeInstanceListener(ApplicationEventListener listener, int mask)` Subscribes to attribute instance events.
`void`	`addAttributeInstanceListener(AttributeInstanceListener listener, int mask)` Subscribes to attribute instance events.
`void`	`addPackageListener(ApplicationEventListener listener, int mask)` Subscribes to package events.
`void`	`addPackageListener(PackageListener listener, int mask)` Subscribes to package events.
`void`	`addProcessDefinitionListener(ApplicationEventListener listener, int mask)` Subscribes to process definition events.
`void`	`addProcessDefinitionListener(ProcessDefinitionListener listener, int mask)` Subscribes to process definition events.
`void`	`addProcessInstanceListener(ApplicationEventListener listener, int mask)` Subscribes to process instance events.
`void`	`addProcessInstanceListener(ProcessInstanceListener listener, int mask)` Subscribes to process instance events.
`void`	`addTransitionListener(ApplicationEventListener listener, int mask)` Subscribes to transition events.
`void`	`addTransitionListener(TransitionListener listener, int mask)` Subscribes to transition events.
`void`	`addWorkItemListener(ApplicationEventListener listener, int mask)` Subscribes to work item events.
`void`	`addWorkItemListener(WorkItemListener listener, int mask)` Subscribes to work item events.
`void`	`fireActivityInstanceAborted(ActivityInstance src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireActivityInstanceCompleted(ActivityInstance src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireActivityInstanceCreated(ActivityInstance src, Activity defn)` Internal use only - do not call.
`void`	`fireActivityInstanceEvent(ActivityInstance src, int id, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireActivityInstanceResumed(ActivityInstance src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireActivityInstanceStarted(ActivityInstance src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireActivityInstanceStopped(ActivityInstance src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireActivityInstanceSuspended(ActivityInstance src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireActivityInstanceTerminated(ActivityInstance src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireAttributeInstanceCreated(AttributeInstance src, DataField defn)` Internal use only - do not call.
`void`	`fireAttributeInstanceDeleted(AttributeInstance src, DataField defn)` Internal use only - do not call.
`void`	`fireAttributeInstanceUpdated(AttributeInstance src, DataField defn, java.lang.Object previousValue)` Internal use only - do not call.
`void`	`firePackageCreated(XPDLPackage src)` Internal use only - do not call.
`void`	`firePackageDeleted(XPDLPackage src)` Internal use only - do not call.
`void`	`firePackageUpdated(XPDLPackage src)` Internal use only - do not call.
`void`	`fireProcessDefinitionCreated(WorkflowProcess src)` Internal use only - do not call.
`void`	`fireProcessDefinitionDeleted(WorkflowProcess src)` Internal use only - do not call.
`void`	`fireProcessDefinitionDisabled(WorkflowProcess src)` Internal use only - do not call.
`void`	`fireProcessDefinitionEnabled(WorkflowProcess src)` Internal use only - do not call.
`void`	`fireProcessDefinitionUpdated(WorkflowProcess src)` Internal use only - do not call.
`void`	`fireProcessInstanceAborted(ProcessInstance src, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireProcessInstanceCompleted(ProcessInstance src, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireProcessInstanceCreated(ProcessInstance src, WorkflowProcess defn)` Internal use only - do not call.
`void`	`fireProcessInstanceDeleted(ProcessInstance src, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireProcessInstanceEvent(ProcessInstance src, int id, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireProcessInstanceResumed(ProcessInstance src, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireProcessInstanceStarted(ProcessInstance src, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireProcessInstanceSuspended(ProcessInstance src, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireProcessInstanceTerminated(ProcessInstance src, WorkflowProcess defn, int previousState)` Internal use only - do not call.
`void`	`fireTransitionEvent(ActivityInstance activityInstance, int id, Transition defn)` Internal use only - do not call.
`void`	`fireTransitionFired(ActivityInstance activityInstance, Transition defn)` Internal use only - do not call.
`void`	`fireWorkItemAborted(WorkItem src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireWorkItemAssigned(WorkItem src, Activity defn)` Internal use only - do not call.
`void`	`fireWorkItemCompleted(WorkItem src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireWorkItemCreated(WorkItem src, Activity defn)` Internal use only - do not call.
`void`	`fireWorkItemEvent(WorkItem src, int id, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireWorkItemResumed(WorkItem src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireWorkItemStarted(WorkItem src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireWorkItemStopped(WorkItem src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireWorkItemSuspended(WorkItem src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`fireWorkItemTerminated(WorkItem src, Activity defn, int previousState)` Internal use only - do not call.
`void`	`removeActivityInstanceListener(ActivityInstanceListener listener)` Unsubscribes from activity instance events.
`void`	`removeActivityInstanceListener(ApplicationEventListener listener)` Unsubscribes from activity instance events.
`void`	`removeAttributeInstanceListener(ApplicationEventListener listener)` Unsubscribes from attribute instance events.
`void`	`removeAttributeInstanceListener(AttributeInstanceListener listener)` Unsubscribes from attribute instance events.
`void`	`removePackageListener(ApplicationEventListener listener)` Unsubscribes from package events.
`void`	`removePackageListener(PackageListener listener)` Unsubscribes from package events.
`void`	`removeProcessDefinitionListener(ApplicationEventListener listener)` Unsubscribes from process definition events.
`void`	`removeProcessDefinitionListener(ProcessDefinitionListener listener)` Unsubscribes from process definition events.
`void`	`removeProcessInstanceListener(ApplicationEventListener listener)` Unsubscribes from process instance events.
`void`	`removeProcessInstanceListener(ProcessInstanceListener listener)` Unsubscribes from process instance events.
`void`	`removeTransitionListener(ApplicationEventListener listener)` Unsubscribes from transition events.
`void`	`removeTransitionListener(WorkItemListener listener)` Unsubscribes from transition events.
`void`	`removeWorkItemListener(ApplicationEventListener listener)` Unsubscribes from work item events.
`void`	`removeWorkItemListener(WorkItemListener listener)` Unsubscribes from work item events.

Methods inherited from interface org.obe.spi.WorkflowService

exit, getServiceManager, getServiceName, init

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:: Constant Field Values

Method Detail

addActivityInstanceListener

public void addActivityInstanceListener(ActivityInstanceListener listener,
                                        int mask)

Subscribes to activity instance events.

Parameters:: listener - The activity instance event listener to add.; mask - Bitmask to specify which events to notify.

addActivityInstanceListener

public void addActivityInstanceListener(ApplicationEventListener listener,
                                        int mask)

Subscribes to activity instance events.

Parameters:: listener - The activity instance event listener to add.; mask - Bitmask to specify which events to notify.

addAttributeInstanceListener

public void addAttributeInstanceListener(AttributeInstanceListener listener,
                                         int mask)

Subscribes to attribute instance events.

Parameters:: listener - The attribute instance event listener to add.; mask - Bitmask to specify which events to notify.

addAttributeInstanceListener

public void addAttributeInstanceListener(ApplicationEventListener listener,
                                         int mask)

Subscribes to attribute instance events.

Parameters:: listener - The attribute instance event listener to add.; mask - Bitmask to specify which events to notify.

addPackageListener

public void addPackageListener(PackageListener listener,
                               int mask)

Subscribes to package events.

Parameters:: listener - The package event listener to add.; mask - Bitmask to specify which events to notify.

addPackageListener

public void addPackageListener(ApplicationEventListener listener,
                               int mask)

Subscribes to package events.

Parameters:: listener - The package event listener to add.; mask - Bitmask to specify which events to notify.

addProcessDefinitionListener

public void addProcessDefinitionListener(ProcessDefinitionListener listener,
                                         int mask)

Subscribes to process definition events.

Parameters:: listener - The process definition event listener to add.; mask - Bitmask to specify which events to notify.

addProcessDefinitionListener

public void addProcessDefinitionListener(ApplicationEventListener listener,
                                         int mask)

Subscribes to process definition events.

Parameters:: listener - The process definition event listener to add.; mask - Bitmask to specify which events to notify.

addProcessInstanceListener

public void addProcessInstanceListener(ProcessInstanceListener listener,
                                       int mask)

Subscribes to process instance events.

Parameters:: listener - The process instance event listener to add.; mask - Bitmask to specify which events to notify.

addProcessInstanceListener

public void addProcessInstanceListener(ApplicationEventListener listener,
                                       int mask)

Subscribes to process instance events.

Parameters:: listener - The process instance event listener to add.; mask - Bitmask to specify which events to notify.

addTransitionListener

public void addTransitionListener(TransitionListener listener,
                                  int mask)

Subscribes to transition events.

Parameters:: listener - The transition event listener to add.; mask - Bitmask to specify which events to notify.

addTransitionListener

public void addTransitionListener(ApplicationEventListener listener,
                                  int mask)

Subscribes to transition events.

Parameters:: listener - The transition event listener to add.; mask - Bitmask to specify which events to notify.

addWorkItemListener

public void addWorkItemListener(WorkItemListener listener,
                                int mask)

Subscribes to work item events.

Parameters:: listener - The work item event listener to add.; mask - Bitmask to specify which events to notify.

addWorkItemListener

public void addWorkItemListener(ApplicationEventListener listener,
                                int mask)

Subscribes to work item events.

Parameters:: listener - The work item event listener to add.; mask - Bitmask to specify which events to notify.