net.officefloor.frame.internal.structure
Interface GovernanceMetaData<I,F extends Enum<F>>

All Superinterfaces:

JobMetaData

All Known Implementing Classes:

GovernanceMetaDataImpl

public interface GovernanceMetaData<I,F extends Enum<F>>
extends JobMetaData

Meta-data of the Governance.

Author:

Daniel Sagenschneider

Method Summary

GovernanceActivity<I,F>	createActivateActivity(GovernanceControl<I,F> governanceControl) Creates a GovernanceActivity to activate the Governance.
ActiveGovernanceManager<I,F>	createActiveGovernance(GovernanceContainer<I,F> governanceContainer, GovernanceControl<I,F> governanceControl, I extensionInterface, ManagedObjectContainer managedobjectContainer, WorkContainer<?> workContainer, int managedObjectContainerRegisteredIndex) Creates the ActiveGovernance.
GovernanceActivity<I,F>	createDisregardActivity(GovernanceControl<I,F> governanceControl) Creates the GovernanceActivity to disregard the Governance.
GovernanceActivity<I,F>	createEnforceActivity(GovernanceControl<I,F> governanceControl) Creates the GovernanceActivity to enforce the Governance.
GovernanceActivity<I,F>	createGovernActivity(ActiveGovernanceControl<F> activeGovernanceControl) Creates a GovernanceActivity to provide Governance to the ManagedObject.
GovernanceContainer<I,F>	createGovernanceContainer(ThreadState threadState, int threadRegisteredIndex) Creates the GovernanceContainer.
JobNode	createGovernanceJob(JobSequence flow, GovernanceActivity<I,F> governanceActivity, JobNode parallelJobNodeOwner) Creates the JobNode for the GovernanceActivity.
FlowMetaData<?>	getFlow(int flowIndex) Obtains the FlowMetaData for the specified index.
GovernanceFactory<? super I,F>	getGovernanceFactory() Obtains the GovernanceFactory.
String	getGovernanceName() Obtains the name of the Governance.

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

createJobActivableSet, getContinueTeam, getEscalationProcedure, getJobName, getNextTaskInFlow, getResponsibleTeam

Method Detail

getGovernanceName

String getGovernanceName()

Obtains the name of the Governance.

Returns:

Name of the Governance.

getGovernanceFactory

GovernanceFactory<? super I,F> getGovernanceFactory()

Obtains the GovernanceFactory.

Returns:

GovernanceFactory.

createGovernanceContainer

GovernanceContainer<I,F> createGovernanceContainer(ThreadState threadState,
                                                   int threadRegisteredIndex)

Creates the GovernanceContainer.

Parameters:

threadState - ThreadState.

threadRegisteredIndex - Index of Governance within the ThreadState.

Returns:

GovernanceContainer.

createActiveGovernance

ActiveGovernanceManager<I,F> createActiveGovernance(GovernanceContainer<I,F> governanceContainer,
                                                    GovernanceControl<I,F> governanceControl,
                                                    I extensionInterface,
                                                    ManagedObjectContainer managedobjectContainer,
                                                    WorkContainer<?> workContainer,
                                                    int managedObjectContainerRegisteredIndex)

Creates the ActiveGovernance.

Parameters:

governanceContainer - GovernanceContainer.

governanceControl - GovernanceControl.

extensionInterface - Extension interface to ManagedObject to enable Governance over the ManagedObject.

managedobjectContainer - ManagedObjectContainer.

workContainer - WorkContainer.

managedObjectContainerRegisteredIndex - Registered index of the ActiveGovernance within the ManagedObjectContainer. This is to enable easier identification of the ActiveGovernance within the ManagedObjectContainer for unregistering.

Returns:

ActiveGovernanceManager.

createActivateActivity

GovernanceActivity<I,F> createActivateActivity(GovernanceControl<I,F> governanceControl)

Creates a GovernanceActivity to activate the Governance.

Parameters:

governanceControl - GovernanceControl.

Returns:

GovernanceActivity to activate the Governance.

createGovernActivity

GovernanceActivity<I,F> createGovernActivity(ActiveGovernanceControl<F> activeGovernanceControl)

Creates a GovernanceActivity to provide Governance to the ManagedObject.

Parameters:

activeGovernanceControl - ActiveGovernanceControl.

Returns:

GovernanceActivity to provide Governance to the ManagedObject.

createEnforceActivity

GovernanceActivity<I,F> createEnforceActivity(GovernanceControl<I,F> governanceControl)

Creates the GovernanceActivity to enforce the Governance.

Parameters:

governanceControl - GovernanceControl.

Returns:

GovernanceActivity to enforce the Governance.

createDisregardActivity

GovernanceActivity<I,F> createDisregardActivity(GovernanceControl<I,F> governanceControl)

Creates the GovernanceActivity to disregard the Governance.

Parameters:

governanceControl - GovernanceContext.

Returns:

GovernanceActivity to disregard the Governance.

getFlow

FlowMetaData<?> getFlow(int flowIndex)

Obtains the FlowMetaData for the specified index.

Parameters:

flowIndex - Index of the FlowMetaData.

Returns:

FlowMetaData for the specified index.

createGovernanceJob

JobNode createGovernanceJob(JobSequence flow,
                            GovernanceActivity<I,F> governanceActivity,
                            JobNode parallelJobNodeOwner)

Creates the JobNode for the GovernanceActivity.

Parameters:

flow - JobSequence for containing this GovernanceActivity.

governanceActivity - GovernanceActivity.

parallelJobNodeOwner - Parallel JobNode owner.

Returns:

JobNode for the GovernanceActivity.