Package org.nuxeo.ecm.automation.core

Class OperationChainContribution

java.lang.Object

org.nuxeo.ecm.automation.core.OperationChainContribution

All Implemented Interfaces:

OperationDescriptor, Descriptor

public class OperationChainContribution
extends Object
implements OperationDescriptor

Author:

Bogdan Stefanescu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationChainContribution.Operation
static class	OperationChainContribution.Param

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	aliases
protected ComponentInstance	contributingComponent
protected String	description
protected boolean	enabled
protected String	id
protected boolean	isPublic
protected OperationChainContribution.Operation[]	ops
protected OperationDocumentation.Param[]	params
protected boolean	replace

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
OperationChainContribution()

Method Summary

Modifier and Type	Method	Description
static OperationChainContribution	contribOf(OperationChain chain, boolean replace)
String[]	getAliases()
String	getCategory()
String	getDescription()
String	getId()	The descriptor id, descriptors with same id are merged.
String	getLabel()
OperationChainContribution.Operation[]	getOps()
OperationDocumentation.Param[]	getParams()
String	getRequires()
String	getSince()
boolean	isEnabled()
Descriptor	merge(Descriptor o)	Returns a descriptor representing other merged into this
static OperationChainContribution.Operation[]	operationsOf(List<OperationParameters> operations)
static OperationDocumentation.Param[]	paramsOf(Map<String,?> args)
boolean	replace()
protected OperationChain	toOperationChain()
OperationType	toType()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove

Field Details

id

protected String id

replace

protected boolean replace

enabled

protected boolean enabled

Since:

2021.17

description

protected String description

ops

protected OperationChainContribution.Operation[] ops

isPublic

protected boolean isPublic

params

protected OperationDocumentation.Param[] params

aliases

protected String[] aliases

Since:

7.1

contributingComponent

protected ComponentInstance contributingComponent

Constructor Details

OperationChainContribution

public OperationChainContribution()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

replace

public boolean replace()

Specified by:

replace in interface OperationDescriptor

Returns:

whether this operation replaces an existing one

Since:

2025.0

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface OperationDescriptor

Returns:

whether this operation is enabled or not

Since:

2025.0

getParams

public OperationDocumentation.Param[] getParams()

getOps

public OperationChainContribution.Operation[] getOps()

getLabel

public String getLabel()

getRequires

public String getRequires()

getCategory

public String getCategory()

getSince

public String getSince()

getDescription

public String getDescription()

getAliases

public String[] getAliases()

contribOf

public static OperationChainContribution contribOf(OperationChain chain,
 boolean replace)

paramsOf

public static OperationDocumentation.Param[] paramsOf(Map<String,?> args)

operationsOf

public static OperationChainContribution.Operation[] operationsOf(List<OperationParameters> operations)

toType

public OperationType toType()

Specified by:

toType in interface OperationDescriptor

Returns:

the OperationType for this descriptor

toOperationChain

protected OperationChain toOperationChain()

merge

public Descriptor merge(Descriptor o)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor