IComponentManagementService (Jadex Active Component Platform 2.4 API.)

```
public interface IComponentManagementService
```
General interface for components that the container can execute.

Method Summary

Methods
Modifier and Type	Method and Description
`IFuture<Void>`	`addComponentListener(IComponentIdentifier comp, ICMSComponentListener listener)` Add an component listener.
`IFuture<Void>`	`addComponentResultListener(IResultListener<Collection<Tuple2<String,Object>>> listener, IComponentIdentifier cid)` Add a result listener.
`ITuple2Future<IComponentIdentifier,Map<String,Object>>`	`createComponent(String model, CreationInfo info)` Create a new component on the platform.
`ITuple2Future<IComponentIdentifier,Map<String,Object>>`	`createComponent(String name, String model, CreationInfo info)` Create a new component on the platform.
`IFuture<IComponentIdentifier>`	`createComponent(String name, String model, CreationInfo info, IResultListener<Collection<Tuple2<String,Object>>> resultlistener)` Deprecated. Use other createComponent methods.
`IFuture<Map<String,Object>>`	`destroyComponent(IComponentIdentifier componentid)` Destroy (forcefully terminate) an component on the platform.
`IFuture<IComponentIdentifier[]>`	`getChildren(IComponentIdentifier cid)` Get the children components of a component.
`IFuture<IComponentDescription[]>`	`getChildrenDescriptions(IComponentIdentifier cid)` Get the children components of a component.
`IFuture<IComponentAdapter>`	`getComponentAdapter(IComponentIdentifier cid)` Get the component adapter for a component identifier.
`IFuture<IComponentDescription>`	`getComponentDescription(IComponentIdentifier cid)` Get the component description of a single component.
`IFuture<IComponentDescription[]>`	`getComponentDescriptions()` Get all component descriptions.
`IFuture<IComponentIdentifier[]>`	`getComponentIdentifiers()` Get the component identifiers.
`IFuture<IExternalAccess>`	`getExternalAccess(IComponentIdentifier cid)` Get the external access of a component.
`IFuture<IComponentIdentifier>`	`getParent(IComponentIdentifier cid)` Deprecated. Use cid.getParent() instead
`IFuture<IComponentIdentifier>`	`getRootIdentifier()` Get the root identifier (platform).
`IFuture<IModelInfo>`	`loadComponentModel(String filename, IResourceIdentifier rid)` Load a component model.
`IFuture<Void>`	`removeComponentListener(IComponentIdentifier comp, ICMSComponentListener listener)` Remove a listener.
`IFuture<Void>`	`removeComponentResultListener(IResultListener<Collection<Tuple2<String,Object>>> listener, IComponentIdentifier cid)` Add a previously added result listener.
`IFuture<Void>`	`resumeComponent(IComponentIdentifier componentid)` Resume the execution of an component.
`IFuture<IComponentDescription[]>`	`searchComponents(IComponentDescription adesc, ISearchConstraints con)` Search for components matching the given description.
`IFuture<IComponentDescription[]>`	`searchComponents(IComponentDescription adesc, ISearchConstraints con, boolean remote)` Search for components matching the given description.
`IFuture<Void>`	`setComponentBreakpoints(IComponentIdentifier componentid, String[] breakpoints)` Set breakpoints for a component.
`IFuture<Void>`	`stepComponent(IComponentIdentifier componentid)` Execute a step of a suspended component.
`IFuture<Void>`	`suspendComponent(IComponentIdentifier componentid)` Suspend the execution of an component.

- Method Detail
  - loadComponentModel
```
IFuture<IModelInfo> loadComponentModel(String filename,
                                     IResourceIdentifier rid)
```
    Load a component model.
    
    Parameters:
    name - The component name.
    
    Returns:
    The model info of the
  - createComponent
```
ITuple2Future<IComponentIdentifier,Map<String,Object>> createComponent(String model,
                                                                     CreationInfo info)
```
    Create a new component on the platform.
    
    Parameters:
    model - The model identifier (e.g. file name).
    info - Additional start information such as parent component or arguments (optional).
    
    Returns:
    The id of the component and the results after the component has been killed.
  - createComponent
```
ITuple2Future<IComponentIdentifier,Map<String,Object>> createComponent(String name,
                                                                     String model,
                                                                     CreationInfo info)
```
    Create a new component on the platform.
    
    Parameters:
    name - The component name or null for automatic generation.
    model - The model identifier (e.g. file name).
    info - Additional start information such as parent component or arguments (optional).
    
    Returns:
    The id of the component and the results after the component has been killed.
  - createComponent
```
IFuture<IComponentIdentifier> createComponent(String name,
                                            String model,
                                            CreationInfo info,
                                            IResultListener<Collection<Tuple2<String,Object>>> resultlistener)
```
    Deprecated. Use other createComponent methods.
    
    Create a new component on the platform.
    
    Parameters:
    name - The component name or null for automatic generation.
    model - The model identifier (e.g. file name).
    info - Additional start information such as parent component or arguments (optional).
    resultlistener - The result listener (if any). Will receive the results of the component execution, after the component has terminated.
    
    Returns:
    The id of the component as future result, when the component has been created and initialized.
  - destroyComponent
```
IFuture<Map<String,Object>> destroyComponent(IComponentIdentifier componentid)
```
    Destroy (forcefully terminate) an component on the platform.
    
    Parameters:
    componentid - The component to destroy.
  - suspendComponent
```
IFuture<Void> suspendComponent(IComponentIdentifier componentid)
```
    Suspend the execution of an component.
    
    Parameters:
    componentid - The component identifier.
  - resumeComponent
```
IFuture<Void> resumeComponent(IComponentIdentifier componentid)
```
    Resume the execution of an component.
    
    Parameters:
    componentid - The component identifier.
  - addComponentResultListener
```
IFuture<Void> addComponentResultListener(IResultListener<Collection<Tuple2<String,Object>>> listener,
                                       IComponentIdentifier cid)
```
    Add a result listener. Also intermediate result listeners can be added. In this case results are immediately fed back when set.
    
    Parameters:
    listener - The result (or intermediate) result listener.
  - removeComponentResultListener
```
IFuture<Void> removeComponentResultListener(IResultListener<Collection<Tuple2<String,Object>>> listener,
                                          IComponentIdentifier cid)
```
    Add a previously added result listener.
    
    Parameters:
    listener - The result (or intermediate) result listener.
  - stepComponent
```
IFuture<Void> stepComponent(IComponentIdentifier componentid)
```
    Execute a step of a suspended component.
    
    Parameters:
    componentid - The component identifier.
    listener - Called when the step is finished (result will be the component description).
  - setComponentBreakpoints
```
IFuture<Void> setComponentBreakpoints(IComponentIdentifier componentid,
                                    String[] breakpoints)
```
    Set breakpoints for a component. Replaces existing breakpoints. To add/remove breakpoints, use current breakpoints from component description as a base.
    
    Parameters:
    componentid - The component identifier.
    breakpoints - The new breakpoints (if any).
  - getRootIdentifier
```
IFuture<IComponentIdentifier> getRootIdentifier()
```
    Get the root identifier (platform).
    
    Returns:
    The root identifier.
  - getComponentIdentifiers
```
IFuture<IComponentIdentifier[]> getComponentIdentifiers()
```
    Get the component identifiers.
    
    Returns:
    The component identifiers. This method should be used with caution when the agent population is large.
  - getComponentDescription
```
IFuture<IComponentDescription> getComponentDescription(IComponentIdentifier cid)
```
    Get the component description of a single component.
    
    Parameters:
    cid - The component identifier.
    
    Returns:
    The component description of this component.
  - getComponentDescriptions
```
IFuture<IComponentDescription[]> getComponentDescriptions()
```
    Get all component descriptions.
    
    Returns:
    The component descriptions of the platform.
  - searchComponents
```
IFuture<IComponentDescription[]> searchComponents(IComponentDescription adesc,
                                                ISearchConstraints con)
```
    Search for components matching the given description.
    
    Returns:
    An array of matching component descriptions.
  - searchComponents
```
IFuture<IComponentDescription[]> searchComponents(IComponentDescription adesc,
                                                ISearchConstraints con,
                                                boolean remote)
```
    Search for components matching the given description.
    
    Returns:
    An array of matching component descriptions.
  - addComponentListener
```
IFuture<Void> addComponentListener(IComponentIdentifier comp,
                                 ICMSComponentListener listener)
```
    Add an component listener. The listener is registered for component changes.
    
    Parameters:
    comp - The component to be listened on (or null for listening on all components).
    listener - The listener to be added.
  - removeComponentListener
```
IFuture<Void> removeComponentListener(IComponentIdentifier comp,
                                    ICMSComponentListener listener)
```
    Remove a listener.
    
    Parameters:
    comp - The component to be listened on (or null for listening on all components).
    listener - The listener to be removed.
  - getExternalAccess
```
IFuture<IExternalAccess> getExternalAccess(IComponentIdentifier cid)
```
    Get the external access of a component.
    
    Parameters:
    cid - The component identifier.
    listener - The result listener (receives an IExternalAccess object).
  - getParent
```
IFuture<IComponentIdentifier> getParent(IComponentIdentifier cid)
```
    Deprecated. Use cid.getParent() instead
    
    Get the parent component of a component.
    
    Parameters:
    cid - The component identifier.
    
    Returns:
    The parent component identifier.
  - getChildren
```
IFuture<IComponentIdentifier[]> getChildren(IComponentIdentifier cid)
```
    Get the children components of a component.
    
    Parameters:
    cid - The component identifier.
    
    Returns:
    The children component identifiers.
  - getChildrenDescriptions
```
IFuture<IComponentDescription[]> getChildrenDescriptions(IComponentIdentifier cid)
```
    Get the children components of a component.
    
    Parameters:
    cid - The component identifier.
    
    Returns:
    The children component descriptions.
  - getComponentAdapter
```
IFuture<IComponentAdapter> getComponentAdapter(IComponentIdentifier cid)
```
    Get the component adapter for a component identifier.
    
    Parameters:
    aid - The component identifier.
    listener - The result listener.

Interface IComponentManagementService

Method Summary

Method Detail

loadComponentModel

createComponent

createComponent

createComponent

destroyComponent

suspendComponent

resumeComponent

addComponentResultListener

removeComponentResultListener

stepComponent

setComponentBreakpoints

getRootIdentifier

getComponentIdentifiers

getComponentDescription

getComponentDescriptions

searchComponents

searchComponents

addComponentListener

removeComponentListener

getExternalAccess

getParent

getChildren

getChildrenDescriptions

getComponentAdapter