net.officefloor.frame.spi.administration.source

Interface AdministratorDutyMetaData<A extends Enum<A>,F extends Enum<F>>

public interface AdministratorDutyMetaData<A extends Enum<A>,F extends Enum<F>>

Meta-data for the Duty of the AdministratorSource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
String	getDutyName() Obtains a unique name to identify this Duty for the Administrator.
AdministratorDutyFlowMetaData<F>[]	getFlowMetaData() Obtains the list of AdministratorDutyFlowMetaData instances should this Duty require instigating a JobSequence.
A	getKey() Obtains the Enum key identifying this Duty.

Method Detail

getDutyName

String getDutyName()

Obtains a unique name to identify this Duty for the Administrator.

Returns:

Name to uniquely identify this Duty.

getKey

A getKey()

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

Returns:

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

getFlowMetaData

AdministratorDutyFlowMetaData<F>[] getFlowMetaData()

Obtains the list of AdministratorDutyFlowMetaData instances should this Duty require instigating a JobSequence.

Returns:

Meta-data of JobSequence instances instigated by this Duty.