Package net.officefloor.frame.internal.structure

Interface Flow

All Superinterfaces:

LinkedListSetEntry<Flow,ThreadState>

All Known Implementing Classes:

FlowImpl

public interface Flow
extends LinkedListSetEntry<Flow,ThreadState>

Represents a sub-graph of the ManagedFunctionContainer graph making up the ThreadState. This enables knowing when to undertake the FlowCallback on completion of all ManagedFunctionContainer instances of the Flow.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
FunctionState	cancel()	Cancels this Flow.
<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>> ManagedFunctionContainer	createAdministrationFunction(ManagedObjectAdministrationMetaData<E,F,G> adminMetaData, ManagedFunctionContainer parallelFunctionOwner)	Creates a new ManagedFunctionContainer contained in this Flow for the ManagedObjectAdministrationMetaData.
FunctionState	createFunction(FunctionLogic logic)	Creates a FunctionState within this Flow for the FunctionLogic.
<F extends java.lang.Enum<F>> ManagedFunctionContainer	createGovernanceFunction(GovernanceActivity<F> governanceActivity, GovernanceMetaData<?,F> governanceMetaData)	Creates a new ManagedFunctionContainer contained in this Flow for the GovernanceActivity.
<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedFunctionContainer	createManagedFunction(java.lang.Object parameter, ManagedFunctionMetaData<O,F> managedFunctionMetaData, boolean isEnforceGovernance, BlockState parallelFunctionOwner)	Creates a new managed ManagedFunctionContainer contained in this Flow for the ManagedFunction.
ThreadState	getThreadState()	Obtains the ThreadState containing this Flow.
FunctionState	managedFunctionComplete(FunctionState function, java.lang.Throwable functionEscalation, EscalationCompletion escalationCompletion)	Flags that the input FunctionState has completed.

Methods inherited from interface net.officefloor.frame.internal.structure.LinkedListSetEntry

getLinkedListSetOwner, getNext, getPrev, setNext, setPrev

Method Detail

createFunction

FunctionState createFunction(FunctionLogic logic)

Creates a FunctionState within this Flow for the FunctionLogic.

Parameters:

logic - FunctionLogic.

Returns:

FunctionState for the FunctionLogic.

createManagedFunction

<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedFunctionContainer createManagedFunction(java.lang.Object parameter,
                                                                                                               ManagedFunctionMetaData<O,F> managedFunctionMetaData,
                                                                                                               boolean isEnforceGovernance,
                                                                                                               BlockState parallelFunctionOwner)

Creates a new managed ManagedFunctionContainer contained in this Flow for the ManagedFunction.

Type Parameters:

O - Dependency key type.

F - Flow key type.

Parameters:

parameter - Parameter for the ManagedFunction.

managedFunctionMetaData - ManagedFunctionMetaData for the new ManagedFunction.

isEnforceGovernance - true to enforce Governance on deactivation.

parallelFunctionOwner - BlockState that is the parallel owner of the new ManagedFunction.

Returns:

New ManagedFunctionContainer.

createGovernanceFunction

<F extends java.lang.Enum<F>> ManagedFunctionContainer createGovernanceFunction(GovernanceActivity<F> governanceActivity,
                                                                                GovernanceMetaData<?,F> governanceMetaData)

Creates a new ManagedFunctionContainer contained in this Flow for the GovernanceActivity.

Type Parameters:

F - Flow key type.

Parameters:

governanceActivity - GovernanceActivity.

governanceMetaData - GovernanceMetaData.

Returns:

New ManagedFunctionContainer.

createAdministrationFunction

<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>> ManagedFunctionContainer createAdministrationFunction(ManagedObjectAdministrationMetaData<E,F,G> adminMetaData,
                                                                                                                              ManagedFunctionContainer parallelFunctionOwner)

Creates a new ManagedFunctionContainer contained in this Flow for the ManagedObjectAdministrationMetaData.

Type Parameters:

E - Extension type.

F - Flow key type.

G - Governance key type.

Parameters:

adminMetaData - ManagedObjectAdministrationMetaData.

parallelFunctionOwner - ManagedFunctionContainer that is the parallel owner of the new ManagedFunction.

Returns:

New ManagedFunctionContainer.

managedFunctionComplete

FunctionState managedFunctionComplete(FunctionState function,
                                      java.lang.Throwable functionEscalation,
                                      EscalationCompletion escalationCompletion)

Flags that the input FunctionState has completed.

Parameters:

function - FunctionState that has completed.

functionEscalation - Possible Escalation from the FunctionState. May be null.

escalationCompletion - Possible EscalationCompletion. May be null.

Returns:

Optional FunctionState to handle completion of the FunctionState.

cancel

FunctionState cancel()

Cancels this Flow.

Returns:

FunctionState to clean up this Flow.

getThreadState

ThreadState getThreadState()

Obtains the ThreadState containing this Flow.

Returns:

ThreadState containing this Flow.