ro.sync.ecss.extensions.commons.id
Class GenerateIDsOperation

java.lang.Object
  ro.sync.ecss.extensions.commons.id.GenerateIDsOperation

All Implemented Interfaces:

AuthorOperation, Extension

Direct Known Subclasses:

GenerateIDsDB4Operation, GenerateIDsDB5Operation, GenerateIDsDITAOperation, GenerateIDsTEIP4Operation, GenerateIDsTEIP5Operation

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

Operation used to auto generate IDs for the elements included in the selected fragment.

Field Summary

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

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

GenerateIDsOperation()

Method Summary

void	doOperation(AuthorAccess authorAccess, ArgumentsMap args) Perform the actual operation.
ArgumentDescriptor[]	getArguments() No Arguments
java.lang.String	getDescription()
protected abstract UniqueAttributesRecognizer	getUniqueAttributesRecognizer()

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateIDsOperation

public GenerateIDsOperation()

Method Detail

doOperation

public void doOperation(AuthorAccess authorAccess,
                        ArgumentsMap args)
                 throws java.lang.IllegalArgumentException,
                        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: Workspace.isStandalone(). 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:

java.lang.IllegalArgumentException - Thrown when one or more arguments are illegal.

AuthorOperationException - Thrown when the operation fails.

See Also:

AuthorOperation.doOperation(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.ArgumentsMap)

getUniqueAttributesRecognizer

protected abstract UniqueAttributesRecognizer getUniqueAttributesRecognizer()

Returns:

The unique attributes handler

getArguments

public ArgumentDescriptor[] getArguments()

No Arguments

Specified by:

getArguments in interface AuthorOperation

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

Returns:

The description of the extension.

See Also:

Extension.getDescription()