agentland.help
Interface AFAIK

All Superinterfaces:

Agent, Good, Managed, Remote, Spy

All Known Implementing Classes:

AFAIKAgent

public interface AFAIK

extends Managed

This is the interface for AFAIKAgent. AFAIKAgentis the heard of the AFAIK system (formerly the Help system). You can use the various ask methods to query AFAIK's knowledge base.

See Also:

AFAIKSpeech, Managed

Fields inherited from interface metaglue.Agent

ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING

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)
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 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

Method Detail

ask

public String ask()
           throws RemoteException

Gets help about the current topic. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.

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)
           throws RemoteException

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.

Parameters:

bPresentFindings - a boolean value

Returns:

a String value of help information.

See Also:

ask(), ask(String), ask(String,boolean), ask(String,String), ask(String,String,boolean)

ask

public String ask(String sTopic)
           throws RemoteException

Gets help about the given topic. The information will be presented on a GUI using the AFAIKNavigatorAgent, and will be spoken through SpeechTextOutput.

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)
           throws RemoteException

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.

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)
           throws RemoteException

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.

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)
           throws RemoteException

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.

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)
           throws RemoteException

getCurrentHelpFile

public HelpFile getCurrentHelpFile()
                            throws RemoteException