oracle.ifs.protocols.commands.utils

Interface Command

All Known Implementing Classes:

CupModeCommand, IfsAddFolderRelationshipCommand, IfsAttributeStringDisplayCommand, IfsBlankCommand, IfsCancelCheckOutCommand, IfsCatCommand, IfsChangeDirectoryCommand, IfsCheckedOutByCommand, IfsCheckInCommand, IfsCheckOutCommand, IfsCloseChannelCommand, IfsCommand, IfsCookieCommand, IfsCopyCommand, IfsCreateDocumentCommand, IfsCreateFolderCommand, IfsDeleteLibraryObjectCommand, IfsDetermineAclCommand, IfsDetermineFormatCommand, IfsDetermineParserCommand, IfsDoesPublicObjectExistByIdCommand, IfsDoesPublicObjectExistByPathCommand, IfsFindPublicObjectByIdCommand, IfsFindPublicObjectByPathCommand, IfsGetAttributeNamesCommand, IfsGetAttributesCommand, IfsGetBeansVersionCommand, IfsGetCurrentUserCommand, IfsHandlePublicObjectVersioningCommand, IfsHelpCommand, IfsInvokeSelectorAndListOutputCommand, IfsInvokeSelectorCommand, IfsIsCheckedOutCommand, IfsIsVersionedCommand, IfsLoginCommand, IfsLogoutCommand, IfsMvCommand, IfsOpenSocketCommand, IfsParseStreamCommand, IfsPasvCommand, IfsPortCommand, IfsRemoveFolderRelationshipCommand, IfsRenderAsRandomAccessContentCommand, IfsRenderAsReaderCommand, IfsRenderAsStreamCommand, IfsSetAttributesCommand, IfsShowAllPathsCommand, IfsStringListCommand, IfsUploadFileCommand

public interface Command

A Command is the interface for all commands.

Version:

0.9

Author:

Kevin Gillett, Patricia Li

See Also:

IfsCommand

(Unpublished)

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Create a default implementation of the command context object.
void	populateNestedCommands(CommandInvoker commandInvoker) Populate all the needed nested commands.
void	run(CommandContext context) Run the commmand.

Method Detail

run

void run(CommandContext context)
  throws IfsException

Run the commmand.

Parameters:

context - the CommandContext object that encapsulates both the parameters and the result of the command.

Throws:

IfsException - if there is any exception thrown.

See Also:

CommandContext

populateNestedCommands

void populateNestedCommands(CommandInvoker commandInvoker)
                     throws IfsException

Populate all the needed nested commands.

CommandInvoker is not guaranteed to exist for the lifetime of the command. Therefore, the command should not keep a reference to the command invoker and it should acquire all the references to the needed commands in this call-back method.

Parameters:

commandInvoker - the CommandInvoker object that can be used to acquire references to the needed sub-commands.

Throws:

IfsException - if there is any exception thrown.

See Also:

CommandInvoker

createCommandContext

CommandContext createCommandContext()
                             throws IfsException

Create a default implementation of the command context object. Subclass should overwrite this class to return an implementation.

Returns:

a instance of the CommandContext.

Throws:

IfsException

See Also:

CommandContext