net.officefloor.frame.spi.administration.source

Interface AdministratorDutyFlowMetaData<F extends Enum<F>>

public interface AdministratorDutyFlowMetaData<F extends Enum<F>>

Describes a JobSequence required by a Duty of the Administrator.

Author:

Daniel Sagenschneider

Method Summary

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

Method Detail

getKey

F getKey()

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

Returns:

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

getArgumentType

Class<?> getArgumentType()

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

This may be null to indicate no argument is passed.

Returns:

Type of the argument that is passed to the JobSequence.

getLabel

String getLabel()

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

Returns:

Descriptive name for this JobSequence.