Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

agentland.help
Class AFAIKAgent

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--metaglue.AgentAgent
                          |
                          +--agentland.util.GoodAgent
                                |
                                +--agentland.resource.ManagedAgent
                                      |
                                      +--agentland.help.AFAIKAgent
All Implemented Interfaces:
AFAIK, Agent, Good, Managed, MetagluePrimitives, Remote, Serializable, Spy
public class AFAIKAgent
extends ManagedAgent
implements AFAIK

AFAIKAgent is the heard of the AFAIK system (formerly the Help system). AFAIKAgent allows another agent to request help using the various ask methods.

See Also:
AFAIKSpeechAgent, ManagedAgent, AFAIK, Serialized Form

Inner classes inherited from class metaglue.AgentAgent
AgentAgent.Attribute
 
Field Summary
protected  HelpFile hCurrent
          I don't think this is currently working
 
Fields inherited from class agentland.resource.ManagedAgent
rm, society
 
Fields inherited from class agentland.util.GoodAgent
alert, notifier
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Fields inherited from interface metaglue.Agent
ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING
 
Constructor Summary
AFAIKAgent()
          Creates a new AFAIKAgent instance.
 
Method Summary
 String ask()
          Gets help about the current topic.
 String ask(boolean bPresentFindings)
          Gets help about the current topic, and optionally present the findings to the user.
 String ask(HelpFile hFile, String sSubtopic)
          Gets help about the given HelpFile and the given subtopic.
 String ask(HelpFile hFile, String sSubtopic, boolean bPresentFindings)
          Gets help about the given HelpFile and the given subtopic, and optionally present the findings to the user.
 String ask(String sTopic)
          Gets help about the given topic.
 String ask(String sTopic, boolean bPresentFindings)
          Gets help about the given topic, and optionally present the findings to the user.
 String ask(String sTopic, String sSubtopic)
          Gets help about the given topic and subtopic.
 String ask(String sTopic, String sSubtopic, boolean bPresentFindings)
          Gets help about the given topic and subtopic, and optionally presents the findings to the user.
 HelpFile getCurrentHelpFile()
           
 
Methods inherited from class agentland.resource.ManagedAgent
connect, getAlert, getNeed, isAvailable, isAvailable, reliesOn, reliesOn, replace, replace, request, request, request, requestAgent, requestAgent, resources, resourcesByAgentID, setNeed, tiedTo, yank, yank, yank
 
Methods inherited from class agentland.util.GoodAgent
addSpy, addSpy, alert, alertString, beep, error, getHistory, getHistoryElement, getPersistentMap, log, notify, removeSpy, removeSpy, resetHistory, safeRely, safeRely, safeRely, setNiceLogName, tell
 
Methods inherited from class metaglue.AgentAgent
addMonitor, alive, defrost, defrostAll, defrostBoolean, defrostInt, defrostString, fixAttribute, fixAttribute, freeze, freeze, freeze, freezeAll, freezeVar, getAgentID, getAttribute, getCatalog, getCatalogID, getDesignation, getFrozenVariables, getLogLevel, getMetaglueAgent, getMetaglueAgentID, getOccupation, getProperties, getSociety, log, log, lookupClass, obtainMetaglueAgent, obtainMetaglueAgent, obtainMetaglueAgentByName, reliesOn, reliesOnSynch, removeFrozen, replaceExceptionHandler, setFreezeName, setLogLevel, setLogName, shutdown, startAgent, startAgentOn, startAgentOn, startup, status, tiedTo, tiedTo, tiedTo, tiedTo, tieToDesignation, whereAreYou
 
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface agentland.resource.Managed
getNeed, replace, replace, resources, yank, yank
 
Methods inherited from interface agentland.util.Good
getHistory, getHistoryElement, resetHistory
 
Methods inherited from interface metaglue.Agent
addMonitor, alive, getAgentID, getMetaglueAgentID, shutdown, startup, whereAreYou
 
Methods inherited from interface agentland.util.Spy
tell
 

Field Detail

hCurrent

protected HelpFile hCurrent
I don't think this is currently working
Constructor Detail

AFAIKAgent

public AFAIKAgent()
           throws RemoteException
Creates a new AFAIKAgent instance.
Throws:
RemoteException - if an error occurs
Method Detail

ask

public String ask()
Gets help about the current topic. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Specified by:
ask in interface AFAIK
Returns:
a String value of help information.
See Also:
ask(boolean), ask(String), ask(String,boolean), ask(String,String), ask(String,String,boolean)

ask

public String ask(boolean bPresentFindings)
Gets help about the current topic, and optionally present the findings to the user. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Specified by:
ask in interface AFAIK
Parameters:
bPresentFindings - a boolean value
Returns:
a String value of help information.
See Also:
ask(), ask(boolean), ask(String), ask(String,boolean), ask(String,String), ask(String,String,boolean)

ask

public String ask(String sTopic)
Gets help about the given topic. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Specified by:
ask in interface AFAIK
Parameters:
sTopic - a String value of the desired help topic.
Returns:
a String value of help information.
See Also:
ask(), ask(boolean), ask(String,boolean), ask(String,String), ask(String,String,boolean)

ask

public String ask(String sTopic,
                  boolean bPresentFindings)
Gets help about the given topic, and optionally present the findings to the user. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Specified by:
ask in interface AFAIK
Parameters:
sTopic - a String value of the desired help topic.
bPresentFindings - a boolean value of whether to use AFAIKNavigatorAgent to present the information.
Returns:
a String value of help information.
See Also:
ask(), ask(boolean), ask(String), ask(String,String), ask(String,String,boolean)

ask

public String ask(String sTopic,
                  String sSubtopic)
Gets help about the given topic and subtopic. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Specified by:
ask in interface AFAIK
Parameters:
sTopic - a String value of the desired topic.
sSubtopic - a String value of the desired subtopic of the desired topic.
Returns:
a String value of help information.
See Also:
ask(), ask(boolean), ask(String), ask(String,boolean), ask(String,String,boolean)

ask

public String ask(String sTopic,
                  String sSubtopic,
                  boolean bPresentFindings)
Gets help about the given topic and subtopic, and optionally presents the findings to the user. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Specified by:
ask in interface AFAIK
Parameters:
sTopic - a String value of the desired topic.
sSubtopic - a String value of the desired subtopic of the desired topic.
bPresentFindings - a boolean value of whether to use AFAIKNavigatorAgent to present the information.
Returns:
a String value of help information.
See Also:
ask(), ask(boolean), ask(String), ask(String,boolean), ask(String,String)

ask

public String ask(HelpFile hFile,
                  String sSubtopic)
Gets help about the given HelpFile and the given subtopic. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Specified by:
ask in interface AFAIK
Parameters:
hFile - a HelpFile value.
sSubtopic - a String value of the subtopic of the specified HelpFile.
Returns:
a String value of the help information.
See Also:
ask(), ask(boolean), ask(String), ask(String,boolean), ask(String,String), ask(String,String,boolean), ask(HelpFile,String,boolean)

ask

public String ask(HelpFile hFile,
                  String sSubtopic,
                  boolean bPresentFindings)
Gets help about the given HelpFile and the given subtopic, and optionally present the findings to the user. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.
Parameters:
hFile - a HelpFile value.
sSubtopic - a String value of the subtopic of the specified HelpFile.
bPresentFindings - a boolean value of whether to use AFAIKNavigatorAgent to present the findings.
Returns:
a String value of the help information.
See Also:
ask(), ask(boolean), ask(String), ask(String,boolean), ask(String,String), ask(String,String,boolean), ask(HelpFile,String)

getCurrentHelpFile

public HelpFile getCurrentHelpFile()
Specified by:
getCurrentHelpFile in interface AFAIK
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD