net.sf.cuf.fw

Interface Application

All Known Subinterfaces:

DialogApplication

public interface Application

The Application interface describes the protocol needed to start/stop an application, to maintain the user properties and to get/set the application models.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_KEY Key for the application object in the argument map passed to the init method of Dc and Pc interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
void	doStart(String[] pArgs) Called to start an application.
void	doStop() Called to stop an application.
Map<String,? super Object>	getAppModel() Returns the models of the applicaton.
Properties	getProperties() Get all properties of the application.
String	getProperty(String pKey, String pDefault) Get a user property of the application, always returns a non-null string if pDefault is not null.
void	setProperty(String pKey, String pValue) Set a user property.

Field Detail

APPLICATION_KEY

static final String APPLICATION_KEY

Key for the application object in the argument map passed to the init method of Dc and Pc interfaces.

See Also:

Constant Field Values

Method Detail

doStart

void doStart(String[] pArgs)

Called to start an application. If the application uses user properties, they should be loaded in this method.

Parameters:

pArgs - the arguments of the static main entry point.

doStop

void doStop()

Called to stop an application. If the application uses user properties, they should be saved in this method. The method shouldn't return.

getProperty

String getProperty(String pKey,
                 String pDefault)

Get a user property of the application, always returns a non-null string if pDefault is not null.

Parameters:

pKey - key of the user property

pDefault - default that should be used if the key is not known

Returns:

string describing the user property for pKey or pDefault

setProperty

void setProperty(String pKey,
               String pValue)

Set a user property.

Parameters:

pKey - key of the user property

pValue - value of the user property

getProperties

Properties getProperties()

Get all properties of the application.

Returns:

properties of the application, never null

getAppModel

Map<String,? super Object> getAppModel()

Returns the models of the applicaton. The map contains String/ValueHolder or String/State or String/any object pairs, so each model has a symbolic name.

Returns:

a Map containing all application models