ro.sync.ecss.extensions.commons.id
Class ConfigureAutoIDElementsOperation
java.lang.Object
ro.sync.ecss.extensions.commons.id.ConfigureAutoIDElementsOperation
- All Implemented Interfaces:
- AuthorOperation, Extension
- Direct Known Subclasses:
- DITAConfigureAutoIDElementsOperation, DocbookConfigureAutoIDElementsOperation, TEIConfigureAutoIDElementsOperation
@API(type=INTERNAL,
src=PUBLIC)
public abstract class ConfigureAutoIDElementsOperation
- extends java.lang.Object
- implements AuthorOperation
Operation used to configure elements for which ID generation is auto.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ConfigureAutoIDElementsOperation
public ConfigureAutoIDElementsOperation()
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)
getDefaultOptions
protected abstract GenerateIDElementsInfo getDefaultOptions()
- Returns:
- The default generation options.
getListMessage
protected abstract java.lang.String getListMessage()
- Returns:
- The message used on the list
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()
© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.