jadex.bridge.service.types.platform

Interface IJadexPlatformInterface

All Known Subinterfaces:

IJadexPlatformBinder

All Known Implementing Classes:

JadexAndroidActivity

public interface IJadexPlatformInterface

Interface to access and control the Jadex platform.

Method Summary

Modifier and Type	Method and Description
boolean	dispatchEvent(jadex.bridge.service.types.context.IJadexAndroidEvent event) Dispatch an event.
jadex.bridge.IExternalAccess	getExternalPlatformAccess() Deprecated. use getPlatformAccess instead.
jadex.bridge.IExternalAccess	getPlatformAccess() Returns the Jadex External Platform Access object.
jadex.bridge.IComponentIdentifier	getPlatformId() Retrieves the platformId of the last started Platform, if any.
<S> jadex.commons.future.IFuture<S>	getService(java.lang.Class<S> serviceClazz) Looks up a service.
<S> jadex.commons.future.IFuture<S>	getService(java.lang.Class<S> serviceClazz, java.lang.String scope) Looks up a service.
<S> S	getsService(java.lang.Class<S> serviceClazz) Looks up a service and returns it synchronously.
boolean	isPlatformRunning() Returns true if given jadex platform is running.
void	registerEventReceiver(IEventReceiver<?> rec) Register an event receiver.
void	shutdownJadexPlatform() Terminates the running jadex platform with the given ID.
jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier>	startComponent(java.lang.String name, java.lang.Class<?> clazz) Start a new Component on a given platform with default CreationInfo.
jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier>	startComponent(java.lang.String name, java.lang.Class<?> clazz, jadex.bridge.service.types.cms.CreationInfo creationInfo) Start a new Component on a given platform.
jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier>	startComponent(java.lang.String name, java.lang.String modelPath) Start a new Component on a given platform.
jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier>	startComponent(java.lang.String name, java.lang.String modelPath, jadex.bridge.service.types.cms.CreationInfo creationInfo) Start a new Component.
jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier>	startMicroAgent(java.lang.String name, java.lang.Class<?> clazz) Deprecated. Use startComponent() instead for all component types.
boolean	unregisterEventReceiver(IEventReceiver<?> rec) Unregister an event receiver.

Method Detail

getExternalPlatformAccess

jadex.bridge.IExternalAccess getExternalPlatformAccess()

Deprecated. use getPlatformAccess instead.

Returns the Jadex External Platform Access object.

Parameters:

platformID -

Returns:

IExternalAccess

getPlatformAccess

jadex.bridge.IExternalAccess getPlatformAccess()

Returns the Jadex External Platform Access object.

Parameters:

platformID -

Returns:

IExternalAccess

isPlatformRunning

boolean isPlatformRunning()

Returns true if given jadex platform is running.

getsService

<S> S getsService(java.lang.Class<S> serviceClazz)

Looks up a service and returns it synchronously.

Parameters:

platformId - Id of the platform to use for lookup

serviceClazz - Class of the service (interface) to find

Returns:

the service

getService

<S> jadex.commons.future.IFuture<S> getService(java.lang.Class<S> serviceClazz)

Looks up a service.

Parameters:

platformId - Id of the platform to use for lookup

serviceClazz - Class of the service (interface) to find

Returns:

Future of the service.

See Also:

getsService

getService

<S> jadex.commons.future.IFuture<S> getService(java.lang.Class<S> serviceClazz,
                                               java.lang.String scope)

Looks up a service.

Parameters:

platformId - Id of the platform to use for lookup

serviceClazz - Class of the service (interface) to find

scope - Search scope. See RequiredServiceInfo constants.

Returns:

Future of the service.

See Also:

getsService

getPlatformId

jadex.bridge.IComponentIdentifier getPlatformId()

Retrieves the platformId of the last started Platform, if any.

Returns:

IComponentIdentifier platformId or null.

shutdownJadexPlatform

void shutdownJadexPlatform()

Terminates the running jadex platform with the given ID.

Parameters:

platformID - Platform to terminate.

startMicroAgent

jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier> startMicroAgent(java.lang.String name,
                                                                                java.lang.Class<?> clazz)

Deprecated. Use startComponent() instead for all component types.

Start a new micro agent on a given platform.

Parameters:

platformId - Identifier of the jadex platform

name - name of the newly created agent

clazz - class of the agent to instantiate

Returns:

ComponentIdentifier of the created agent.

startComponent

jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier> startComponent(java.lang.String name,
                                                                               java.lang.String modelPath,
                                                                               jadex.bridge.service.types.cms.CreationInfo creationInfo)

Start a new Component.

Parameters:

name - name of the newly created component

modelPath - Path to the model file of the new component

creationInfo - CreationInfo to pass to the started Component.

Returns:

ComponentIdentifier of the created component.

startComponent

jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier> startComponent(java.lang.String name,
                                                                               java.lang.String modelPath)

Start a new Component on a given platform.

Parameters:

platformId - Identifier of the jadex platform

name - name of the newly created component

modelPath - Path to the model file of the new component

Returns:

ComponentIdentifier of the created component.

startComponent

jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier> startComponent(java.lang.String name,
                                                                               java.lang.Class<?> clazz,
                                                                               jadex.bridge.service.types.cms.CreationInfo creationInfo)

Start a new Component on a given platform.

Parameters:

name - name of the newly created component

clazz - Class of the new component

creationInfo - CreationInfo to pass to the started Component.

Returns:

ComponentIdentifier of the created component.

startComponent

jadex.commons.future.IFuture<jadex.bridge.IComponentIdentifier> startComponent(java.lang.String name,
                                                                               java.lang.Class<?> clazz)

Start a new Component on a given platform with default CreationInfo.

Parameters:

name - name of the newly created component

modelPath - Path to the model file of the new component

Returns:

ComponentIdentifier of the created component.

registerEventReceiver

void registerEventReceiver(IEventReceiver<?> rec)

Register an event receiver.

Parameters:

rec -

unregisterEventReceiver

boolean unregisterEventReceiver(IEventReceiver<?> rec)

Unregister an event receiver.

Parameters:

rec -

Returns:

true if, the given receiver was registered before removal.

dispatchEvent

boolean dispatchEvent(jadex.bridge.service.types.context.IJadexAndroidEvent event)
               throws WrongEventClassError

Dispatch an event.

Parameters:

event -

Returns:

true, if an receiver was found for this event.

Throws:

WrongEventClassError