Jadex 0.96-beta1

jadex.runtime
Interface ICapability

All Superinterfaces:
IElement
All Known Subinterfaces:
IExternalAccess

public interface ICapability
extends IElement

A capability is a self-contained agent module as specified in an agent definition file (ADF).


Method Summary
 void addAgentListener(IAgentListener listener, boolean async)
          Add an agent listener
 void addSubcapability(String name, String capafile)
          Deprecated.  
 void deregisterSubcapability(IMCapabilityReference subcap)
          Deregister a subcapability.
 BasicAgentIdentifier getAgentIdentifier()
          Get the agent identifier.
 String getAgentName()
          Get the agent name.
 IBeliefbase getBeliefbase()
          Get the belief base.
 IEventbase getEventbase()
          Get the event base.
 IExpressionbase getExpressionbase()
          Get the expression base.
 IExternalAccess getExternalAccess()
          Get the scope.
 IGoalbase getGoalbase()
          Get the goal base.
 String getInitialStateName()
          Get the initial state name.
 Logger getLogger()
          Get the logger.
 IPlanbase getPlanbase()
          Get the plan base.
 Object getPlatformAgent()
          Get the platform agent.
 String getPlatformType()
          Get the platform type.
 IPropertybase getPropertybase()
          Get the property base.
 void killAgent()
          Kill the agent.
 void registerSubcapability(IMCapabilityReference subcap)
          Register a subcapability.
 void removeAgentListener(IAgentListener listener)
          Add an agent listener
 void removeSubcapability(String name)
          Deprecated.  
 
Methods inherited from interface jadex.runtime.IElement
getModelElement, getName
 

Method Detail

getExternalAccess

IExternalAccess getExternalAccess()
Get the scope.

Returns:
The scope.

getBeliefbase

IBeliefbase getBeliefbase()
Get the belief base.

Returns:
The belief base.

getGoalbase

IGoalbase getGoalbase()
Get the goal base.

Returns:
The goal base.

getPlanbase

IPlanbase getPlanbase()
Get the plan base.

Returns:
The plan base.

getEventbase

IEventbase getEventbase()
Get the event base.

Returns:
The event base.

getExpressionbase

IExpressionbase getExpressionbase()
Get the expression base.

Returns:
The expression base.

getPropertybase

IPropertybase getPropertybase()
Get the property base.

Returns:
The property base.

addSubcapability

void addSubcapability(String name,
                      String capafile)
Deprecated. 

Add a new subcapability.

Parameters:
name - The name to give to the new capability.
capafile - The capability identifier or filename.

removeSubcapability

void removeSubcapability(String name)
Deprecated. 

Remove a subcapability.

Parameters:
name - The subcapability name.

registerSubcapability

void registerSubcapability(IMCapabilityReference subcap)
Register a subcapability.

Parameters:
subcap - The subcapability.

deregisterSubcapability

void deregisterSubcapability(IMCapabilityReference subcap)
Deregister a subcapability.

Parameters:
subcap - The subcapability.

getLogger

Logger getLogger()
Get the logger.

Returns:
The logger.

getAgentName

String getAgentName()
Get the agent name.

Returns:
The agent name.

getInitialStateName

String getInitialStateName()
Get the initial state name.

Returns:
The initial state name.

getAgentIdentifier

BasicAgentIdentifier getAgentIdentifier()
Get the agent identifier.

Returns:
The agent identifier.

getPlatformAgent

Object getPlatformAgent()
Get the platform agent.

Returns:
The platform agent.

getPlatformType

String getPlatformType()
Get the platform type.

Returns:
The platform type.

killAgent

void killAgent()
Kill the agent.


addAgentListener

void addAgentListener(IAgentListener listener,
                      boolean async)
Add an agent listener

Parameters:
listener - The listener.
async - True, if the notification should be done on a separate thread.

removeAgentListener

void removeAgentListener(IAgentListener listener)
Add an agent listener

Parameters:
listener - The listener.

Jadex 0.96-beta1

Submit a bug or feature
For further API reference and developer documentation, see the Jadex User Guide and the Jadex Tutorial. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Copyright (C) 2002-2007 Lars Braubach, Alexander Pokahr - University of Hamburg. Use is subject to license terms.