Package ro.sync.ecss.extensions.api.webapp

Class AuthorOperationWithResult

java.lang.Object

ro.sync.ecss.extensions.api.webapp.AuthorOperationWithResult

All Implemented Interfaces:

Extension

Direct Known Subclasses:

TableMoveOrCopyColumnOperation, TableMoveOrCopyRowsOperation

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class AuthorOperationWithResult
extends Object
implements Extension

Operation that returns a result when invoked from the Web Author JS API.

Since:

18.1

Constructor Summary

Constructors

Constructor	Description
AuthorOperationWithResult()

Method Summary

Modifier and Type	Method	Description
abstract String	doOperation(AuthorDocumentModel model, ArgumentsMap args)	Performs the actual operation and return a result to be sent to the client-side code.
String	getDescription()

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorOperationWithResult

public AuthorOperationWithResult()

Method Details

doOperation

public abstract String doOperation(AuthorDocumentModel model,
 ArgumentsMap args)
                            throws IllegalArgumentException,
AuthorOperationException

Performs the actual operation and return a result to be sent to the client-side code.

Parameters:

model - The web author document model.

args - The map of arguments. The argument names are the names passed by the calling JS code.

Returns:

The result of the operation that will be passed to the client-side code.

Throws:

IllegalArgumentException - Thrown when one or more arguments are illegal.

AuthorOperationException - Thrown when the operation fails.

getDescription

public String getDescription()

Specified by:

getDescription in interface Extension

Returns:

the description of this operation.