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

Class SetReadOnlyStatusOperation

java.lang.Object

ro.sync.ecss.extensions.commons.operations.SetReadOnlyStatusOperation

All Implemented Interfaces:

AuthorOperation, Extension

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

Operation that sets the read-only status of a document.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ARGUMENT_READ_ONLY	The read-only status argument.
static java.lang.String	ARGUMENT_READ_ONLY_CODE	The code for the reason for the document being read-only.
static java.lang.String	ARGUMENT_READ_ONLY_REASON	The reason for the document being read-only.
protected static ArgumentDescriptor[]	ARGUMENTS	The arguments descriptor.

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
SetReadOnlyStatusOperation()

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_READ_ONLY

public static final java.lang.String ARGUMENT_READ_ONLY

The read-only status argument. The value is true if the document should be made read-only.

See Also:

Constant Field Values

ARGUMENT_READ_ONLY_REASON

public static final java.lang.String ARGUMENT_READ_ONLY_REASON

The reason for the document being read-only. If the document is set as read-only and the parameter is not specified, a deafult message will be presented to the user when trying to edit the document..

See Also:

Constant Field Values

ARGUMENT_READ_ONLY_CODE

public static final java.lang.String ARGUMENT_READ_ONLY_CODE

The code for the reason for the document being read-only. It will be accessible through API. The difference between this argument and ARGUMENT_READ_ONLY_REASON is that this code does not change with the UI language.

See Also:

Constant Field Values

ARGUMENTS

protected static final ArgumentDescriptor[] ARGUMENTS

The arguments descriptor.

Constructor Detail

SetReadOnlyStatusOperation

public SetReadOnlyStatusOperation()

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)

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()