fipaos.platform.dfgui
Class DFGUIAgent

fipaos.agent.FIPAOSAgent
  |
  +--fipaos.platform.dfgui.DFGUIAgent
Direct Known Subclasses:
DFGUITestAgent, SwingDFGUIAgent

public abstract class DFGUIAgent
extends FIPAOSAgent

This a basic shell for DFGUI implementations to extend - all Agent based interactions are handled by this class, enabling developers to concentrate on the UI to present this functionality/information


Inner classes inherited from class fipaos.agent.FIPAOSAgent
FIPAOSAgent.TopLevelHandlerTask

Fields inherited from class fipaos.agent.FIPAOSAgent
_registered_with, _state

Constructor Summary
DFGUIAgent(String name, String platform, String owner)
          Generic constructor - see FIPAOSAgent

Method Summary
 abstract voidderegistered(AgentID df, DFAgentDescription df_desc)
          Invoked when an Agent has been deregistered with a DF that has previously been searched
 synchronized MapfederatedSearch(AgentID df, int depth)
          Send a federated search to the given DF, and retrieve the results
 abstract voidmodified(AgentID df, DFAgentDescription df_desc)
          Invoked when an Agent has been modified with a DF that has previously been searched
 abstract voidregistered(AgentID df, DFAgentDescription df_desc)
          Invoked when an Agent has been registered with a DF that has previously been searched
 synchronized voidshutdown()
          Shutdown the DFGUI Agent "nicely" (attempts to cancel subscriptions to DF's before killing the Agent).

Methods inherited from class fipaos.agent.FIPAOSAgent
activate, forward, forward, getAID, getCurrentConversation, getHAP, getLocalAMS, getLocalAMSAID, getLocalDF, getLocalDFAID, getNewConversation, getOwnership, getPlatformProfile, getProfile, getState, isShutdown, notify, notify, notifyDone, notifyError, notifyMessageInEndedConversation, notifyMessageUndeliverable, notifyTimeout, sendNotUnderstood, sendNotUnderstood, setMessageSender, waitForPushLock

Constructor Detail

DFGUIAgent

public DFGUIAgent(String name, String platform, String owner)
Generic constructor - see FIPAOSAgent
Parameters:
name - Name of the Agent
platform - Location of the platform profile
owner - Owner of this Agent
Method Detail

deregistered

public abstract void deregistered(AgentID df, DFAgentDescription df_desc)
Invoked when an Agent has been deregistered with a DF that has previously been searched
Parameters:
df - DF associated with this event
df_desc - DF description of the entry that has been updated

federatedSearch

public synchronized Map federatedSearch(AgentID df, int depth)
Send a federated search to the given DF, and retrieve the results

modified

public abstract void modified(AgentID df, DFAgentDescription df_desc)
Invoked when an Agent has been modified with a DF that has previously been searched
Parameters:
df - DF associated with this event
df_desc - DF description of the entry that has been updated

registered

public abstract void registered(AgentID df, DFAgentDescription df_desc)
Invoked when an Agent has been registered with a DF that has previously been searched
Parameters:
df - DF associated with this event
df_desc - DF description of the entry that has been updated

shutdown

public synchronized void shutdown()
Shutdown the DFGUI Agent "nicely" (attempts to cancel subscriptions to DF's before killing the Agent).

Association Links

to Class java.util.Map

to Class java.util.Map

to Class fipaos.platform.dfgui.DFGUIAgent