org.mule.runtime.api.meta.model.operation

Interface OperationModel

All Superinterfaces:

ComponentModel, DescribedObject, EnrichableModel, HasDisplayModel, NamedObject, ParameterizedModel, ThrowsErrors

All Known Subinterfaces:

RouterModel, ScopeModel

public interface OperationModel
extends ComponentModel

A definition of an operation in a ExtensionModel.

Operation models implement the flyweight pattern. This means that a given operation should only be represented by only one instance of this class. Thus, if the same operation is contained by different HasOperationModels instances, then each of those containers should reference the same operation model instance.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
default void	accept(ComponentModelVisitor visitor) Accepts a ComponentModelVisitor
ExecutionType	getExecutionType()
OutputModel	getOutputAttributes() Returns a MetadataType for the value that this operation sets on the output Message.getAttributes() field.
boolean	isBlocking()

Methods inherited from interface org.mule.runtime.api.meta.model.ComponentModel

getOutput, getStereotypes, isTransactional, requiresConnection, supportsStreaming

Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.api.meta.model.parameter.ParameterizedModel

getAllParameterModels, getParameterGroupModels

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

getDisplayModel

Methods inherited from interface org.mule.runtime.api.meta.model.error.ThrowsErrors

getErrorModels

Method Detail

getOutputAttributes

OutputModel getOutputAttributes()

Returns a MetadataType for the value that this operation sets on the output Message.getAttributes() field.

If this operation does not modify that value, then a NullType instance will be returned. Notice however that this does not mean that the property will be set to null on the message, it means that whatever value it had before the operation was executed will be preserved after it returns.

Specified by:

getOutputAttributes in interface ComponentModel

Returns:

a MetadataType representing the attribute types for the output messages

isBlocking

boolean isBlocking()

Returns:

Whether this operation is blocking or non blocking execution is supported

getExecutionType

ExecutionType getExecutionType()

Returns:

this operation's ExecutionType

accept

default void accept(ComponentModelVisitor visitor)

Accepts a ComponentModelVisitor

Specified by:

accept in interface ComponentModel

Parameters:

visitor - a ComponentModelVisitor