com.im.df.api
Interface DFSchemaProvider.State

Enclosing interface:

DFSchemaProvider

public static interface DFSchemaProvider.State

State description

Method Summary

DFSchemaProvider.StepInfo	getLastStepInfo() Return information about last step
String	getName() Name of the state like "disconnected", "logged in" etc.
String	getNextPhaseCommand() Return next phase command text which can be used for example as button text (examples: "Login", "Connect", etc.)
String	getNextPhaseProgressName() Return appropriate next phase progress handle name (examples: "Logging", "Connecting", etc.)
Object	getOptions() Return options for proceedToNextState() method.
DFSchema	getSchema() Get schema if ready.
boolean	isInitial() Is the current state initial (it means are all artefacts cleaned up and schema is completelly disconnected)

Method Detail

getName

String getName()

Name of the state like "disconnected", "logged in" etc.

getNextPhaseCommand

String getNextPhaseCommand()

Return next phase command text which can be used for example as button text (examples: "Login", "Connect", etc.)

getNextPhaseProgressName

String getNextPhaseProgressName()

Return appropriate next phase progress handle name (examples: "Logging", "Connecting", etc.)

getOptions

Object getOptions()

Return options for proceedToNextState() method. This is javabean and can be customised.

Returns:

The always the same instance of options! This instance (if any) is then used in proceedToNextState method

getSchema

DFSchema getSchema()

Get schema if ready. This method returns the schema if current state is final and schema is active. Otherwise it returns null. This call is never blocking for the longer time and can be called from any thread.

getLastStepInfo

DFSchemaProvider.StepInfo getLastStepInfo()

Return information about last step

isInitial

boolean isInitial()

Is the current state initial (it means are all artefacts cleaned up and schema is completelly disconnected)