This project has retired. For details please refer to its Attic page.

org.apache.lenya.workflow
Interface SynchronizedWorkflowInstances

All Known Implementing Classes:

SynchronizedWorkflowInstancesImpl, WorkflowDocumentSet

public interface SynchronizedWorkflowInstances

Synchronized workflow instances.

A set of workflow instances with the same workflow schema can be synchronized. If a transition in this schema is marked as synchronized, it can only be invoked on all instances in the set at the same time.

When a workflow event is invoked on a set of synchronized workflow instances, the transition is invoked only if

• all instances are in the source state of the transition, and
• all conditions of the transition are complied for all instances.

Then the transition is invoked for all instances in the set.

A common usecase of this concept is the simultaneous publishing of a set of documents (all language versions of a document, a section, ...).

Method Summary

Event[]	getExecutableEvents(Situation situation) Returns all executable events.
void	invoke(Situation situation, Event event) Invokes an event on all documents.

Method Detail

getExecutableEvents

Event[] getExecutableEvents(Situation situation)
                            throws WorkflowException

Returns all executable events.

Throws:

WorkflowException

See Also:

WorkflowInstance.getExecutableEvents(org.apache.lenya.workflow.Situation)

invoke

void invoke(Situation situation,
            Event event)
            throws WorkflowException

Invokes an event on all documents.

Throws:

WorkflowException

See Also:

WorkflowInstance.invoke(org.apache.lenya.workflow.Situation, org.apache.lenya.workflow.Event)