public class OperationDocumentation extends Object implements Comparable<OperationDocumentation>, Serializable
Modifier and Type | Class and Description |
---|---|
static class |
OperationDocumentation.Param |
Modifier and Type | Field and 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 and Description |
---|
OperationDocumentation(String id) |
Modifier and Type | Method and 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() |
public String[] signature
public String deprecatedSince
public boolean addToStudio
public String implementationClass
public String description
public OperationDocumentation.Param[] params
public WidgetDefinition[] widgetDefinitions
public OperationChainContribution.Operation[] operations
public OperationDocumentation(String id)
public static OperationDocumentation copyForAlias(OperationDocumentation od, String alias)
OperationDocumentation
for an alias.
Array fields of od
are shallow copied.
public int compareTo(OperationDocumentation o)
compareTo
in interface Comparable<OperationDocumentation>
public String getDescription()
public String getDeprecatedSince()
public boolean isAddToStudio()
public String getImplementationClass()
public boolean isChain()
public String[] getSignature()
public String getCategory()
public String getRequires()
public OperationDocumentation.Param[] getParams()
public String[] getAliases()
public void setAliases(String[] aliases)
public OperationChainContribution.Operation[] getOperations()
Copyright © 2017 Nuxeo. All rights reserved.