info.magnolia.commands.impl

Class RestorePreviousVersionCommand

java.lang.Object

info.magnolia.commands.MgnlCommand

info.magnolia.commands.impl.BaseRepositoryCommand

info.magnolia.commands.impl.RuleBasedCommand

info.magnolia.commands.impl.RestorePreviousVersionCommand

All Implemented Interfaces:

Command, Cloneable

public class RestorePreviousVersionCommand
extends RuleBasedCommand

Command to restore a node and all its descendants to their previous version.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_INCLUDING_CHILDREN
static String	ATTRIBUTE_PARENT_NODE_TYPE_ONLY
static int	HOLD_LOCK_IN_SECONDS

Fields inherited from class info.magnolia.commands.impl.RuleBasedCommand

ATTRIBUTE_RULE

Fields inherited from interface info.magnolia.commands.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor and Description
RestorePreviousVersionCommand(VersionManager versionManager)

Method Summary

Modifier and Type	Method and Description
boolean	execute(Context context) This is the actual method to be overridden in descendant classes.
protected Rule	getDefaultRule()
boolean	isParentNodeTypeOnly()
protected void	restoreAllChildren(javax.jcr.Node node, String parentNodeType) Restores all descendant nodes according to the following strategy: Restore descendants of the same type as the parent, if isParentNodeTypeOnly() is set to true Restore descendants according to the configured Rule for allowed node-types Restore descendants of type mgnl:metaData and node-types defined by itemTypes parameter of command definition (fallback behavior).

Methods inherited from class info.magnolia.commands.impl.RuleBasedCommand

getItemTypes, getRule, release, setItemTypes, setRule

Methods inherited from class info.magnolia.commands.impl.BaseRepositoryCommand

getJCRNode, getNode, getPath, getRepository, getUuid, setPath, setRepository, setUuid

Methods inherited from class info.magnolia.commands.MgnlCommand

clone, execute, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_PARENT_NODE_TYPE_ONLY

public static final String ATTRIBUTE_PARENT_NODE_TYPE_ONLY

See Also:

Constant Field Values

ATTRIBUTE_INCLUDING_CHILDREN

public static final String ATTRIBUTE_INCLUDING_CHILDREN

See Also:

Constant Field Values

HOLD_LOCK_IN_SECONDS

public static final int HOLD_LOCK_IN_SECONDS

See Also:

Constant Field Values

Constructor Detail

RestorePreviousVersionCommand

@Inject
public RestorePreviousVersionCommand(VersionManager versionManager)

Method Detail

execute

public boolean execute(Context context)
                throws Exception

Description copied from class: MgnlCommand

This is the actual method to be overridden in descendant classes.

Specified by:

execute in class MgnlCommand

Throws:

Exception

getDefaultRule

protected Rule getDefaultRule()

Overrides:

getDefaultRule in class RuleBasedCommand

restoreAllChildren

protected void restoreAllChildren(javax.jcr.Node node,
                                  String parentNodeType)
                           throws javax.jcr.RepositoryException

Restores all descendant nodes according to the following strategy:

• Restore descendants of the same type as the parent, if isParentNodeTypeOnly() is set to true
• Restore descendants according to the configured Rule for allowed node-types
• Restore descendants of type mgnl:metaData and node-types defined by itemTypes parameter of command definition (fallback behavior).

Throws:

javax.jcr.RepositoryException

See Also:

isParentNodeTypeOnly(), RuleBasedCommand.getRule()

isParentNodeTypeOnly

public boolean isParentNodeTypeOnly()

Returns:

true if the command context contains an parentNodeTypeOnly parameter whose value is true, false (default setting) otherwise.