net.officefloor.frame.internal.structure

Interface FlowAsset

All Known Subinterfaces:

JobSequence, ThreadState

All Known Implementing Classes:

JobSequenceImpl, ThreadStateImpl

public interface FlowAsset

JobSequence Asset.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
boolean	waitOnFlow(JobNode jobNode, long timeout, Object token, JobNodeActivateSet activateSet) Flags for the input JobNode to wait on this JobSequence.

Method Detail

waitOnFlow

boolean waitOnFlow(JobNode jobNode,
                   long timeout,
                   Object token,
                   JobNodeActivateSet activateSet)

Flags for the input JobNode to wait on this JobSequence.

Note that the JobNode may not wait on a JobSequence contained in the same ThreadState as that of the JobNode. This would result on the ThreadState waiting on itself and subsequently no progression of the ThreadState.

Parameters:

jobNode - JobNode to wait on this JobSequence.

timeout - The maximum time to wait in milliseconds for the JobSequence to complete.

token - A token added to the FlowJoinTimedOutEscalation to aid in identifying which JobSequence join timed out. May be null.

activateSet - JobNodeActivateSet to activate the JobNode instances should JobSequence be completed.

Returns:

true if waiting on this JobSequence, otherwise false if JobSequence has already completed and not waiting.