com.ecyrd.jspwiki.event

Class WorkflowEvent

java.lang.Object

java.util.EventObject

com.ecyrd.jspwiki.event.WikiEvent

com.ecyrd.jspwiki.event.WorkflowEvent

All Implemented Interfaces:

java.io.Serializable

public final class WorkflowEvent
extends WikiEvent

WorkflowEvent indicates that a state change to a Workflow: started, running, waiting, completed, aborted. These correspond exactly to the states described in the Workflow. All events are logged with priority INFO.

Since:

2.3.79

Author:

Andrew Jaquith

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORTED If a Step has elected to abort the Workflow.
static int	COMPLETED After the Workflow has finished processing all Steps, without errors.
static int	CREATED After Workflow instantiation.
static int	RUNNING fter the Workflow has been started (or re-started) using the Workflow.start() method, but before it has finished processing all Steps.
static int	STARTED After the Workflow has been instantiated, but before it has been started using the Workflow.start() method.
static int	WAITING When the Workflow has temporarily paused, for example because of a pending Decision.

Fields inherited from class com.ecyrd.jspwiki.event.WikiEvent

ERROR, UNDEFINED

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
WorkflowEvent(java.lang.Object src, int type) Constructs a new instance of this event type, which signals a security event has occurred.

Method Summary

Modifier and Type	Method and Description
java.lang.String	eventName(int type) Returns a textual representation of an event type.
Workflow	getWorkflow() Convenience method that returns the Workflow to which the event applied.
java.lang.String	toString() Prints a String (human-readable) representation of this object.

Methods inherited from class com.ecyrd.jspwiki.event.WikiEvent

eventName, getType, getTypeDescription, getWhen, isValidType, setType

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CREATED

public static final int CREATED

After Workflow instantiation.

See Also:

Constant Field Values

STARTED

public static final int STARTED

After the Workflow has been instantiated, but before it has been started using the Workflow.start() method.

See Also:

Constant Field Values

RUNNING

public static final int RUNNING

fter the Workflow has been started (or re-started) using the Workflow.start() method, but before it has finished processing all Steps.

See Also:

Constant Field Values

WAITING

public static final int WAITING

When the Workflow has temporarily paused, for example because of a pending Decision.

See Also:

Constant Field Values

COMPLETED

public static final int COMPLETED

After the Workflow has finished processing all Steps, without errors.

See Also:

Constant Field Values

ABORTED

public static final int ABORTED

If a Step has elected to abort the Workflow.

See Also:

Constant Field Values

Constructor Detail

WorkflowEvent

public WorkflowEvent(java.lang.Object src,
                     int type)

Constructs a new instance of this event type, which signals a security event has occurred. The source parameter is required, and may not be null. When the WikiSecurityEvent is constructed, the security logger WikiSecurityEvent#log is notified.

Parameters:

src - the source of the event, which can be any object: a wiki page, group or authentication/authentication/group manager.

type - the type the type of event

Method Detail

getWorkflow

public final Workflow getWorkflow()

Convenience method that returns the Workflow to which the event applied.

Returns:

the Workflow

toString

public final java.lang.String toString()

Prints a String (human-readable) representation of this object.

Overrides:

toString in class WikiEvent

Returns:

the String representation

See Also:

Object.toString()

eventName

public final java.lang.String eventName(int type)

Returns a textual representation of an event type.

Parameters:

type - the type the type

Returns:

the string representation