WorkflowInstance

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> lenya >> [ workflow overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.lenya.workflow.WorkflowInstance

SOURCE |

Download org.apache.lenya.workflow.WorkflowInstance

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.lenya.workflow
Interface WorkflowInstance

public interface WorkflowInstance

A workflow instance is an incarnation of a workflow schema. It consists of

a current state,
a mapping which assigns values to all state variables.

Method Summary

void addWorkflowListener(WorkflowListener listener)
          Adds a workflow listener.

State getCurrentState()
          Returns the current state of this WorkflowInstance.

Event[] getExecutableEvents(Situation situation)
          Returns the executable events in a certain situation.

boolean getValue(java.lang.String variableName)
          Returns the current value of a variable.

Workflow getWorkflow()
          Returns the workflow this instance belongs to.

void invoke(Situation situation, Event event)
          Indicates that the user invoked an event.

boolean isSynchronized(Event event)
          Returns if the transition for a certain event is synchronized.

void removeWorkflowListener(WorkflowListener listener)
          Removes a workflow listener.

Method Detail

getWorkflow

public Workflow getWorkflow()

Returns the workflow this instance belongs to.

getCurrentState

public State getCurrentState()

Returns the current state of this WorkflowInstance.

getExecutableEvents

public Event[] getExecutableEvents(Situation situation)
                            throws WorkflowException

Returns the executable events in a certain situation.

invoke

public void invoke(Situation situation,
                   Event event)
            throws WorkflowException

Indicates that the user invoked an event.

getValue

public boolean getValue(java.lang.String variableName)
                 throws WorkflowException

Returns the current value of a variable.

addWorkflowListener

public void addWorkflowListener(WorkflowListener listener)

Adds a workflow listener.

removeWorkflowListener

public void removeWorkflowListener(WorkflowListener listener)

Removes a workflow listener.

isSynchronized

public boolean isSynchronized(Event event)
                       throws WorkflowException

Returns if the transition for a certain event is synchronized.