jadex.application.runtime
Interface IApplication

All Known Implementing Classes:

ApplicationInterpreter

public interface IApplication

Interface for applications. Defines methods of the application object, that may be used from the outside.

Method Summary

String[]	getAllImports() Get the imports.
MApplicationType	getApplicationType() Get the application type.
Map	getArguments() Get the arguments.
String	getComponentFilename(String type) Get the file name for a logical type name of a subcomponent of this application.
IComponentIdentifier	getComponentIdentifier() Get the component identifier.
String	getComponentType(IComponentIdentifier cid) Get the logical component type for a given component id.
Map	getResults() Get the results of the component (considering it as a functionality).
IServiceProvider	getServiceProvider() Get the service container.
IFuture	scheduleStep(IComponentStep step) Schedule a step of the application component.

Method Detail

getComponentIdentifier

IComponentIdentifier getComponentIdentifier()

Get the component identifier.

Returns:

The component id of the application.

getServiceProvider

IServiceProvider getServiceProvider()

Get the service container.

Returns:

The service container.

getComponentType

String getComponentType(IComponentIdentifier cid)

Get the logical component type for a given component id.

Parameters:

cid - The component id.

Returns:

The logical type name of the component as defined in the application descriptor.

getComponentFilename

String getComponentFilename(String type)

Get the file name for a logical type name of a subcomponent of this application.

Parameters:

type - The logical type name of the component as defined in the application descriptor.

Returns:

The file name.

getAllImports

String[] getAllImports()

Get the imports.

Returns:

The imports.

getArguments

Map getArguments()

Get the arguments.

Returns:

The arguments.

getResults

Map getResults()

Get the results of the component (considering it as a functionality). Note: The method cannot make use of the asynchrnonous result listener mechanism, because the it is called when the component is already terminated (i.e. no invokerLater can be used).

Returns:

The results map (name -> value).

getApplicationType

MApplicationType getApplicationType()

Get the application type.

scheduleStep

IFuture scheduleStep(IComponentStep step)

Schedule a step of the application component. May safely be called from external threads.

Parameters:

step - Code to be executed as a step.