org.bibalex.daf.entities.phase
Interface IDatabaseDataEntry

All Known Implementing Classes:

DatabaseDataEntryDialog

public interface IDatabaseDataEntry

Determines the functionality needed by classes to collect data form the user.

Author:

Shehab.Kamal

Method Summary

void	collect() When overridden in an implementing class, starts collecting user data. This method can wrap showing a modal dialog or other types of swing components. Note to implementors: This method should be a blocking method not to make the code continue while the user is supplying the data.
void	configure(DatabaseDef definition, DatabaseInfoDef finishInfo, DatabaseInfoDef startInfo) When overriden in an implementing class, configures the instance to collect the data.
org.w3c.dom.Node	getData() When overridden in an implementing class, gets the data that the user has enterd.

Method Detail

configure

void configure(DatabaseDef definition,
               DatabaseInfoDef finishInfo,
               DatabaseInfoDef startInfo)

When overriden in an implementing class, configures the instance to collect the data.

Parameters:

definition - The DatabaseDef used to configure the instance.

finishInfo - The DatabaseInfoDef used to populate the controls with values.

startInfo - The DatabaseInfoDef used to populate the controls with values. This parameter can be null.

collect

void collect()
             throws PhaseActionException

When overridden in an implementing class, starts collecting user data.
This method can wrap showing a modal dialog or other types of swing components.
Note to implementors: This method should be a blocking method not to make the code continue while the user is supplying the data.

Throws:

PhaseActionException - If the user data couldn't be collected.

getData

org.w3c.dom.Node getData()

When overridden in an implementing class, gets the data that the user has enterd.

Returns:

An Xml node representing the user data.
If the user eneterd no data an empty Node is returned. Howevere if the user cancelled the process null is returned.
The distinction between cancelling and providing no data is implementation specific.