WFInstanceListener (Maximo API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- psdi.workflow.WFInstanceListener

All Implemented Interfaces:

EventListener
```
public class WFInstanceListener
extends java.lang.Object
implements EventListener
```
for issue 74974 - need to clear EventResponses created by the instance when it is deactivated. Need to do this after actions are complete because ER might have been created/destroyed since the last save and if we try to delete in the same transaction we'll get a rowupdate error.
EventResponses created by the workflow are of two types. Actions may register responders, usually to prevent status changes. Wait nodes also register responders. To clear both types of responders, we delete all responders whose ref is set to this instance. Custom Actions which register responders should set the ref Mbo to the instance so they can be cleaned up correctly when the instance completes or is killed.
Created static listener class - issue 07-14085.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`destroy()` Unregister this listener.
`void`	`eventAction(EventMessage em)`
`boolean`	`eventValidate(EventMessage em)` Only interested when instances become inactive.
`static WFInstanceListener`	`init()` Returns the listener object.
`void`	`postCommitEventAction(EventMessage em)` After the asset is written to the database, this method updates the ancestor records.
`void`	`preSaveEventAction(EventMessage em)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - init
```
public static WFInstanceListener init()
```
    Returns the listener object. Creates one if not in existance yet.
    
    Returns:
    
    the listener
  - eventValidate
```
public boolean eventValidate(EventMessage em)
                      throws MXException
```
    Only interested when instances become inactive.
    
    Specified by:
    
    eventValidate in interface EventListener
    
    Throws:
    
    MXException
    
    See Also:
    
    EventListener.eventValidate(psdi.server.event.EventMessage)
  - preSaveEventAction
```
public void preSaveEventAction(EventMessage em)
                        throws MXException
```
    Specified by:
    
    preSaveEventAction in interface EventListener
    
    Throws:
    
    MXException
  - eventAction
```
public void eventAction(EventMessage em)
                 throws MXException
```
    Specified by:
    
    eventAction in interface EventListener
    
    Throws:
    
    MXException
  - postCommitEventAction
```
public void postCommitEventAction(EventMessage em)
                           throws MXException
```
    After the asset is written to the database, this method updates the ancestor records.
    
    Specified by:
    
    postCommitEventAction in interface EventListener
    
    Throws:
    
    MXException
  - destroy
```
public static void destroy()
```
    Unregister this listener.