oracle.ifs.protocols.commands

Class IfsHelpCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsHelpCommand

All Implemented Interfaces:

Command

public class IfsHelpCommand
extends IfsCommand

A IfsHelpCommand supports a basic help operation. It stores usaged and detailed help strings for retrival via keys. This command maintains state is the form of help strings mapped to a key. Care should be taken to create a new Command for each application.

Inputs:

• helpKey : Object (optional)

Outputs :

• detailedHelp : String
• usageHelp : String

Description:

• Returns the detailed help and usage help stored for a given key. If the key is null then the complete usage is returned.

Version:

0.9

Author:

Kevin Gillett

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsHelpCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
void	addDetailedHelpResourceKey(Object key, String resourceKey)
void	addUsageHelpResourceKey(Object key, String resourceKey)
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CommandContext context) Execute a CommandContext.
protected void	execute(HelpContext context) Executes a HelpContext.

Methods inherited from class oracle.ifs.protocols.commands.utils.IfsCommand

populateNestedCommands, postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsHelpCommand

public IfsHelpCommand()

Defualt Constructor

(Published)

Method Detail

execute

protected void execute(CommandContext context)
                throws IfsException

Execute a CommandContext.

Overrides:

execute in class IfsCommand

Parameters:

context - the command context.

Throws:

IfsException - if execution fails

(Published)

execute

protected void execute(HelpContext context)
                throws IfsException

Executes a HelpContext.

Throws:

IfsException

(Published)

addDetailedHelpResourceKey

public void addDetailedHelpResourceKey(Object key,
                                       String resourceKey)

addUsageHelpResourceKey

public void addUsageHelpResourceKey(Object key,
                                    String resourceKey)

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Returns a CommandContext to be used throughout the invocation.

Specified by:

createCommandContext in interface Command

Overrides:

createCommandContext in class IfsCommand

Returns:

a instance of the CommandContext.

Throws:

IfsException

See Also:

CommandContext

(Published)