ro.sync.ecss.extensions.commons.operations

Class ExecuteMultipleActionsOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.ExecuteMultipleActionsOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

ExecuteMultipleWebappCompatibleActionsOperation

@API(type=INTERNAL,
     src=PUBLIC)
public class ExecuteMultipleActionsOperation
extends java.lang.Object
implements AuthorOperation

An implementation of an operation which runs a sequence of actions, defined as a list of IDs. The actions must be defined by the corresponding framework, or one of the common actions for all frameworks supplied by Oxygen.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_IDS Actions IDs argument name.

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 and Description
ExecuteMultipleActionsOperation() Constructor.

Method Summary

Modifier and Type	Method and Description
void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
java.util.List<java.lang.Object>	getActions(AuthorAccess authorAccess, java.lang.Object actionIDs) Get all the actions from this 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

ACTION_IDS

public static final java.lang.String ACTION_IDS

Actions IDs argument name.

See Also:

Constant Field Values

Constructor Detail

ExecuteMultipleActionsOperation

public ExecuteMultipleActionsOperation()

Constructor.

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()

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

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(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

getActions

public java.util.List<java.lang.Object> getActions(AuthorAccess authorAccess,
                                                   java.lang.Object actionIDs)
                                            throws AuthorOperationException

Get all the actions from this operation.

Parameters:

authorAccess - Author access.

actionIDs - Action ids.

Returns:

The list with all actions.

Throws:

java.lang.IllegalArgumentException

AuthorOperationException

getArguments

public ArgumentDescriptor[] getArguments()

Specified by:

getArguments in interface AuthorOperation

Returns:

An array of ArgumentDescriptor representing the arguments this operation uses.

See Also:

AuthorOperation.getArguments()