Package jadex.bridge.component

Interface IExternalSubcomponentsFeature

All Superinterfaces:

IExternalComponentFeature

All Known Subinterfaces:

IBDIAgent, IExternalAccess, IInternalAccess, ISubcomponentsFeature

All Known Implementing Classes:

ComponentPlanBDI, HelloWorldBDI, HelloWorldPlan2, IndexChangeBDI, InterfaceInjectionBDI, PlanMethodInjectionBDI, PlanReasonInjectionBDI, SayHelloBDI

public interface IExternalSubcomponentsFeature
extends IExternalComponentFeature

External perspective of the subcomponents feature.

Method Summary

Modifier and Type	Method	Description
IFuture<IExternalAccess>	addComponent(java.lang.Object pojocomponent)	Starts a new POJO-component.
IFuture<IExternalAccess>	createComponent(CreationInfo info)	Starts a new component.
IIntermediateFuture<IExternalAccess>	createComponents(CreationInfo... infos)	Starts a set of new components, in order of dependencies.
ISubscriptionIntermediateFuture<CMSStatusEvent>	createComponentWithEvents(CreationInfo info)	Starts a new component while continuously receiving status events (create, result updates, termination).
IFuture<IComponentIdentifier[]>	getChildren(java.lang.String type, IComponentIdentifier parent)	Get the children (if any) component identifiers.
IFuture<java.lang.String>	getFileName(java.lang.String ctype)	Get the model name of a component type.
IFuture<java.lang.String>	getLocalTypeAsync()	Get the local type name of this component as defined in the parent.
IIntermediateFuture<Tuple2<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>>>	killComponents(IComponentIdentifier... cids)	Stops a set of components, in order of dependencies.
IFuture<IComponentDescription[]>	searchComponents(IComponentDescription adesc, ISearchConstraints con)	Search for subcomponents matching the given description.

Method Detail

getFileName

IFuture<java.lang.String> getFileName(java.lang.String ctype)

Get the model name of a component type.

Parameters:

ctype - The component type.

Returns:

The model name of this component type.

getLocalTypeAsync

IFuture<java.lang.String> getLocalTypeAsync()

Get the local type name of this component as defined in the parent.

Returns:

The type of this component type.

addComponent

IFuture<IExternalAccess> addComponent(java.lang.Object pojocomponent)

Starts a new POJO-component.

Parameters:

pojocomponent - The pojo object used as component.

Returns:

The id of the component and the results after the component has been killed.

createComponent

IFuture<IExternalAccess> createComponent(CreationInfo info)

Starts a new component.

Parameters:

infos - Start information.

Returns:

The acces to the component.

createComponentWithEvents

ISubscriptionIntermediateFuture<CMSStatusEvent> createComponentWithEvents(CreationInfo info)

Starts a new component while continuously receiving status events (create, result updates, termination).

Parameters:

infos - Start information.

Returns:

Status events.

createComponents

IIntermediateFuture<IExternalAccess> createComponents(CreationInfo... infos)

Starts a set of new components, in order of dependencies.

Parameters:

infos - Start information.

Returns:

The id of the component and the results after the component has been killed.

killComponents

IIntermediateFuture<Tuple2<IComponentIdentifier,java.util.Map<java.lang.String,java.lang.Object>>> killComponents(IComponentIdentifier... cids)

Stops a set of components, in order of dependencies.

Parameters:

infos - Start information.

Returns:

The id of the component and the results after the component has been killed.

searchComponents

IFuture<IComponentDescription[]> searchComponents(IComponentDescription adesc,
                                                  ISearchConstraints con)

Search for subcomponents matching the given description.

Returns:

An array of matching component descriptions.

getChildren

IFuture<IComponentIdentifier[]> getChildren(java.lang.String type,
                                            IComponentIdentifier parent)

Get the children (if any) component identifiers.

Parameters:

type - The local child type.

parent - The parent (null for this).

Returns:

The children component identifiers.