Package ro.sync.ecss.extensions.commons.operations

Class DeleteElementOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.DeleteElementsOperation

ro.sync.ecss.extensions.commons.operations.DeleteElementOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class DeleteElementOperation
extends DeleteElementsOperation

An implementation of a delete operation that deletes the node at caret.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARGUMENT_ELEMENT_XPATH_LOCATION	The XPath location that identifies the element.

Fields inherited from class ro.sync.ecss.extensions.commons.operations.DeleteElementsOperation

ARGUMENT_ELEMENT_XPATH_LOCATIONS, arguments

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
DeleteElementOperation()	Constructor for the delete element operation.

Method Summary

Modifier and Type	Method	Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args)	Perform the actual operation.
ArgumentDescriptor[]	getArguments()
java.lang.String	getDescription()

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_ELEMENT_XPATH_LOCATION

public static final java.lang.String ARGUMENT_ELEMENT_XPATH_LOCATION

The XPath location that identifies the element. Empty/null for the current element. The value is elementLocation.

See Also:

Constant Field Values

Constructor Detail

DeleteElementOperation

public DeleteElementOperation()

Constructor for the delete element operation.

Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws AuthorOperationException

Description copied from interface: AuthorOperation

Perform the actual operation. You can check if the operation was invoked from the oXygen standalone application or from the oXygen plugin for Eclipse by using the method: ApplicationInformationAccess.getPlatform(). To get to the Workspace you may use: AuthorAccess.getWorkspaceAccess().

Specified by:

doOperation in interface AuthorOperation

Overrides:

doOperation in class DeleteElementsOperation

Parameters:

authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.

args - The map of arguments. All the arguments defined by method AuthorOperation.getArguments() must be present in the map of arguments.

Throws:

AuthorOperationException - Thrown when the operation fails.

See Also:

AuthorOperation.doOperation(AuthorAccess, ArgumentsMap)

getArguments

public ArgumentDescriptor[] getArguments()

Specified by:

getArguments in interface AuthorOperation

Overrides:

getArguments in class DeleteElementsOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Overrides:

getDescription in class DeleteElementsOperation

Returns:

The description of the extension.

See Also:

Extension.getDescription()