Package org.nuxeo.ecm.automation
Interface OperationType
-
- All Known Implementing Classes:
ChainTypeImpl
,OperationTypeImpl
,ScriptingOperationTypeImpl
public interface OperationType
Describe an operation class. Each registered operation will be stored in the registry as an instance of this class.- Author:
- Bogdan Stefanescu
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description OperationType
clone()
boolean
equals(Object obj)
String[]
getAliases()
The operation ID Aliases array.String
getContributingComponent()
Gets the name of the component that contributed the operation.OperationDocumentation
getDocumentation()
String
getId()
default String
getInputType()
The input type of a chain/operation.List<InvokableMethod>
getMethods()
InvokableMethod[]
getMethodsMatchingInput(Class<?> in)
AutomationService
getService()
Gets the service that registered that type.Class<?>
getType()
int
hashCode()
boolean
isEnabled()
void
merge(OperationType other)
Object
newInstance(OperationContext ctx, Map<String,Object> args)
static OperationType
typeof(OperationChain chain, boolean replace)
-
-
-
Method Detail
-
getId
String getId()
-
getAliases
String[] getAliases()
The operation ID Aliases array.- Since:
- 7.1
-
getType
Class<?> getType()
-
getInputType
default String getInputType()
The input type of a chain/operation. If set, the following input types {"document", "documents", "blob", "blobs"} for all 'run method(s)' will handled. Other values will be adapted as java.lang.Object. If not set, Automation will set the input type(s) as the 'run methods(s)' parameter types (by introspection).- Since:
- 7.4
-
newInstance
Object newInstance(OperationContext ctx, Map<String,Object> args) throws OperationException
- Throws:
OperationException
-
getService
AutomationService getService()
Gets the service that registered that type.
-
getDocumentation
OperationDocumentation getDocumentation() throws OperationException
- Throws:
OperationException
-
getContributingComponent
String getContributingComponent()
Gets the name of the component that contributed the operation.
-
getMethodsMatchingInput
InvokableMethod[] getMethodsMatchingInput(Class<?> in)
-
getMethods
List<InvokableMethod> getMethods()
- Since:
- 5.7.2
-
typeof
static OperationType typeof(OperationChain chain, boolean replace)
-
isEnabled
boolean isEnabled()
- Since:
- 2021.17
-
clone
OperationType clone()
- Since:
- 2021.17
-
merge
void merge(OperationType other)
- Since:
- 2021.17
-
-