oracle.ifs.protocols.commands

Class IfsHelpContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsHelpContext

All Implemented Interfaces:

HelpContext, CommandContext

public class IfsHelpContext
extends IfsCommandContext
implements HelpContext

IfsHelpContext is the base implmentation of a HelpContext.

Version:

0.9

Author:

Kevin Gillett

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsHelpContext() The Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the CommandState. does not throw.
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 key) 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 key) Sets the usage help resource key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IfsHelpContext

public IfsHelpContext()
               throws IfsException

The Constructor.

Throws:

IfsException

(Published)

Method Detail

clear

public void clear()

Clears the CommandState. does not throw.

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getHelpKey

public Object getHelpKey()
                  throws IfsException

Gets the help key to obtain the help for.

Specified by:

getHelpKey in interface HelpContext

Throws:

IfsException

(Published)

setHelpKey

public void setHelpKey(Object key)
                throws IfsException

Sets the help key to obtain the help for.

Specified by:

setHelpKey in interface HelpContext

Throws:

IfsException

(Published)

getMessagePrefix

public String getMessagePrefix()
                        throws IfsException

Gets the message prefix.

Specified by:

getMessagePrefix in interface HelpContext

Throws:

IfsException

(Published)

setMessagePrefix

public void setMessagePrefix(String prefix)
                      throws IfsException

Sets the message prefix.

Specified by:

setMessagePrefix in interface HelpContext

Throws:

IfsException

(Published)

getDetailedHelpResourceKey

public String getDetailedHelpResourceKey()
                                  throws IfsException

Gets the detailed help resource key.

Specified by:

getDetailedHelpResourceKey in interface HelpContext

Throws:

IfsException

(Published)

setDetailedHelpResourceKey

public void setDetailedHelpResourceKey(String key)
                                throws IfsException

Sets the detailed help resource key.

Specified by:

setDetailedHelpResourceKey in interface HelpContext

Throws:

IfsException

(Published)

getUsageHelpResourceKey

public String getUsageHelpResourceKey()
                               throws IfsException

Gets the usage help resource key.

Specified by:

getUsageHelpResourceKey in interface HelpContext

Throws:

IfsException

(Published)

setUsageHelpResourceKey

public void setUsageHelpResourceKey(String key)
                             throws IfsException

Sets the usage help resource key.

Specified by:

setUsageHelpResourceKey in interface HelpContext

Throws:

IfsException

(Published)

getUsageHelpKeys

public Hashtable getUsageHelpKeys()
                           throws IfsException

Gets the hashtable of usage help keys

Specified by:

getUsageHelpKeys in interface HelpContext

Throws:

IfsException

(Published)

setUsageHelpKeys

public void setUsageHelpKeys(Hashtable usageHelp)
                      throws IfsException

Sets the hashtable of usage help keys

Specified by:

setUsageHelpKeys in interface HelpContext

Throws:

IfsException

(Published)