Package org.nuxeo.ecm.automation

Class OperationDocumentation

java.lang.Object

org.nuxeo.ecm.automation.OperationDocumentation

All Implemented Interfaces:

Comparable<OperationDocumentation>

public class OperationDocumentation
extends Object
implements Comparable<OperationDocumentation>

Author:

Bogdan Stefanescu, Guillaume Renard

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationDocumentation.Param

Field Summary

Fields

Modifier and Type	Field	Description
boolean	addToStudio
String[]	aliases
String	category
String	deprecatedSince
String	description
String	id
String	implementationClass
String	label
OperationChainContribution.Operation[]	operations	The operations listing in case of a chain.
OperationDocumentation.Param[]	params
String	requires
String[]	signature	an array of size multiple of 2.
String	since
String	url
WidgetDefinition[]	widgetDefinitions

Constructor Summary

Constructors

Constructor	Description
OperationDocumentation(String id)

Method Summary

Modifier and Type	Method	Description
int	compareTo(OperationDocumentation o)
static OperationDocumentation	copyForAlias(OperationDocumentation od, String alias)	Returns a simple copy of an OperationDocumentation for an alias.
String[]	getAliases()
String	getCategory()
String	getDeprecatedSince()
String	getDescription()
String	getId()
String	getImplementationClass()
String	getLabel()
OperationChainContribution.Operation[]	getOperations()
OperationDocumentation.Param[]	getParams()
String	getRequires()
String[]	getSignature()
String	getSince()
String	getUrl()
boolean	isAddToStudio()
boolean	isChain()
void	setAliases(String[] aliases)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

id

public String id

aliases

public String[] aliases

Since:

7.1

signature

public String[] signature

an array of size multiple of 2. Each pair in the array is the input and output type of a method.

category

public String category

label

public String label

requires

public String requires

since

public String since

deprecatedSince

public String deprecatedSince

Since:

5.9.1

addToStudio

public boolean addToStudio

Since:

5.9.1

implementationClass

public String implementationClass

Since:

5.9.1

description

public String description

params

public OperationDocumentation.Param[] params

widgetDefinitions

public WidgetDefinition[] widgetDefinitions

operations

public OperationChainContribution.Operation[] operations

The operations listing in case of a chain.

url

public String url

Constructor Details

OperationDocumentation

public OperationDocumentation(String id)

Method Details

copyForAlias

public static OperationDocumentation copyForAlias(OperationDocumentation od,
 String alias)

Returns a simple copy of an OperationDocumentation for an alias.

Array fields of od are shallow copied.

Since:

9.1

compareTo

public int compareTo(OperationDocumentation o)

Specified by:

compareTo in interface Comparable<OperationDocumentation>

getDescription

public String getDescription()

getSince

public String getSince()

Since:

5.9.1

getDeprecatedSince

public String getDeprecatedSince()

Since:

5.9.1

isAddToStudio

public boolean isAddToStudio()

Since:

5.9.1

getImplementationClass

public String getImplementationClass()

Since:

5.9.1

isChain

public boolean isChain()

Since:

5.9.4

getSignature

public String[] getSignature()

getCategory

public String getCategory()

getId

public String getId()

getUrl

public String getUrl()

getLabel

public String getLabel()

getRequires

public String getRequires()

getParams

public OperationDocumentation.Param[] getParams()

getAliases

public String[] getAliases()

setAliases

public void setAliases(String[] aliases)

getOperations

public OperationChainContribution.Operation[] getOperations()

toString

public String toString()

Overrides:

toString in class Object