Package net.officefloor.compile.spi.administration.source

Interface AdministrationFlowMetaData<F extends java.lang.Enum<F>>

public interface AdministrationFlowMetaData<F extends java.lang.Enum<F>>

Describes a Flow required by the Administration.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
java.lang.Class<?>	getArgumentType()	Obtains the Class of the argument that is passed to the Flow.
F	getKey()	Obtains the Enum key identifying this Flow.
java.lang.String	getLabel()	Provides a descriptive name for this Flow.

Method Detail

getKey

F getKey()

Obtains the Enum key identifying this Flow. If null then Flow will be referenced by this instance's index in the array returned from AdministrationMetaData.

Returns:

Enum key identifying the Flow or null indicating identified by an index.

getArgumentType

java.lang.Class<?> getArgumentType()

Obtains the Class of the argument that is passed to the Flow.

This may be null to indicate no argument is passed.

Returns:

Type of the argument that is passed to the Flow.

getLabel

java.lang.String getLabel()

Provides a descriptive name for this Flow. This is useful to better describe the Flow.

Returns:

Descriptive name for this Flow.