info.magnolia.commands.chain

Interface Command

All Superinterfaces:

Cloneable

All Known Subinterfaces:

Chain, Filter

All Known Implementing Classes:

BaseRepositoryCommand, ChainBase, DelegateCommand, DeleteCommand, ExportCommand, ExtractCommentCommand, ImportCommand, LogCommand, MarkNodeAsDeletedCommand, MessageCommand, MgnlCommand, RuleBasedCommand, VersionCommand

public interface Command
extends Cloneable

A replacement for the org.apache.commons.chain.Command interface.

A Command encapsulates a unit of processing work to be performed, whose purpose is to examine and/or modify the state of a transaction that is represented by a Context.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CONTINUE_PROCESSING
static boolean	PROCESSING_COMPLETE

Method Summary

Methods

Modifier and Type	Method and Description
Command	clone() This method allows to create new clone of a command, so the instances in the CommandManager's catalogs are masters, and the execution always uses clone created by this method. NOTE: CommandsManager clone the command instances by standard Java cloning mechanism.
boolean	execute(Context context)

Field Detail

CONTINUE_PROCESSING

static final boolean CONTINUE_PROCESSING

See Also:

Constant Field Values

PROCESSING_COMPLETE

static final boolean PROCESSING_COMPLETE

See Also:

Constant Field Values

Method Detail

execute

boolean execute(Context context)
                throws Exception

Throws:

Exception

clone

Command clone()
              throws CloneNotSupportedException

This method allows to create new clone of a command, so the instances in the CommandManager's catalogs are masters, and the execution always uses clone created by this method.
NOTE: CommandsManager clone the command instances by standard Java cloning mechanism. If deep copy is needed then you have to override clone method of command.

Throws:

CloneNotSupportedException