oracle.ifs.protocols.commands

Interface HelpContext

All Superinterfaces:

CommandContext

All Known Implementing Classes:

IfsHelpContext

public interface HelpContext
extends CommandContext

HelpContext encapsulates the state of an IfsHelpCommand.

Version:

0.9

Author:

Kevin Gillett

(Unpublished)

Method Summary

Modifier and Type	Method and Description
String	getDetailedHelpResourceKey() Gets the detailed help resource key.
Object	getHelpKey() Gets the help key to obtain the help for.
String	getMessagePrefix() Gets the message prefix.
Hashtable	getUsageHelpKeys() Gets the hashtable of usage help keys
String	getUsageHelpResourceKey() Gets the usage help resource key.
void	setDetailedHelpResourceKey(String detail) Sets the detailed help resource key.
void	setHelpKey(Object key) Sets the help key to obtain the help for.
void	setMessagePrefix(String prefix) Sets the message prefix.
void	setUsageHelpKeys(Hashtable usageHelp) Sets the hashtable of usage help keys
void	setUsageHelpResourceKey(String usage) Sets the usage help resource key.

Methods inherited from interface oracle.ifs.protocols.commands.utils.CommandContext

clear

Method Detail

getHelpKey

Object getHelpKey()
           throws IfsException

Gets the help key to obtain the help for.

Throws:

IfsException

(Published)

setHelpKey

void setHelpKey(Object key)
         throws IfsException

Sets the help key to obtain the help for.

Throws:

IfsException

(Published)

getMessagePrefix

String getMessagePrefix()
                 throws IfsException

Gets the message prefix.

Throws:

IfsException

(Published)

setMessagePrefix

void setMessagePrefix(String prefix)
               throws IfsException

Sets the message prefix.

Throws:

IfsException

(Published)

getDetailedHelpResourceKey

String getDetailedHelpResourceKey()
                           throws IfsException

Gets the detailed help resource key.

Throws:

IfsException

(Published)

setDetailedHelpResourceKey

void setDetailedHelpResourceKey(String detail)
                         throws IfsException

Sets the detailed help resource key.

Throws:

IfsException

(Published)

getUsageHelpResourceKey

String getUsageHelpResourceKey()
                        throws IfsException

Gets the usage help resource key.

Throws:

IfsException

(Published)

setUsageHelpResourceKey

void setUsageHelpResourceKey(String usage)
                      throws IfsException

Sets the usage help resource key.

Throws:

IfsException

(Published)

getUsageHelpKeys

Hashtable getUsageHelpKeys()
                    throws IfsException

Gets the hashtable of usage help keys

Throws:

IfsException

(Published)

setUsageHelpKeys

void setUsageHelpKeys(Hashtable usageHelp)
               throws IfsException

Sets the hashtable of usage help keys

Throws:

IfsException

(Published)