org.mule.tooling.client.api.extension.model.operation

Class OperationModel

java.lang.Object

org.mule.tooling.client.api.extension.model.operation.OperationModel

All Implemented Interfaces:

ComponentModel, ParameterizedModel, HasSemanticTerms

public class OperationModel
extends Object
implements ComponentModel

A definition of an operation in a ExtensionModel.

Since:

1.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OperationModel()
	OperationModel(String name, String description, List<ParameterGroupModel> parameterGroupModels, DisplayModel displayModel, boolean blocking, Set<ErrorModel> errors, OutputModel output, OutputModel outputAttributes, boolean transaction, boolean requiresConnection, boolean supportsStreaming, StereotypeModel stereotype, List<? extends NestableElementModel> nestedComponents, MetadataKeyIdModel metadataKeyIdModel, DeprecationModel deprecationModel) Deprecated.
	OperationModel(String name, String description, List<ParameterGroupModel> parameterGroupModels, DisplayModel displayModel, boolean blocking, Set<ErrorModel> errors, OutputModel output, OutputModel outputAttributes, boolean transaction, boolean requiresConnection, boolean supportsStreaming, StereotypeModel stereotype, List<? extends NestableElementModel> nestedComponents, MetadataKeyIdModel metadataKeyIdModel, DeprecationModel deprecationModel, TypeResolversInformationModel typeResolversInformationModel, SampleDataProviderModel sampleDataProviderModel)
	OperationModel(String name, String description, List<ParameterGroupModel> parameterGroupModels, DisplayModel displayModel, boolean blocking, Set<ErrorModel> errors, OutputModel output, OutputModel outputAttributes, boolean transaction, boolean requiresConnection, boolean supportsStreaming, StereotypeModel stereotype, List<? extends NestableElementModel> nestedComponents, MetadataKeyIdModel metadataKeyIdModel, DeprecationModel deprecationModel, TypeResolversInformationModel typeResolversInformationModel, SampleDataProviderModel sampleDataProviderModel, Set<String> semanticTerms)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Feature<DeprecationModel>	getDeprecationModel()
String	getDescription() Returns the component's description
Optional<DisplayModel>	getDisplayModel()
Set<ErrorModel>	getErrorModels()
Optional<MetadataKeyIdModel>	getMetadataKeyIdModel()
String	getName() Gets the name of the object
List<? extends NestableElementModel>	getNestedComponents()
OutputModel	getOutput()
OutputModel	getOutputAttributes()
Optional<ParameterGroupModel>	getParameterGroupModel(String name)
List<ParameterGroupModel>	getParameterGroupModels()
Feature<SampleDataProviderModel>	getSampleDataProviderModel()
Set<String>	getSemanticTerms() Returns the semantic terms contained in this model.
StereotypeModel	getStereotype()
Feature<TypeResolversInformationModel>	getTypeResolversInformationModel()
int	hashCode()
boolean	isBlocking()
boolean	isTransactional()
boolean	requiresConnection()
boolean	supportsStreaming()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mule.tooling.client.api.extension.model.ParameterizedModel

getAllParameterModels

Constructor Detail

OperationModel

protected OperationModel()

OperationModel

@Deprecated
public OperationModel(String name,
                                  String description,
                                  List<ParameterGroupModel> parameterGroupModels,
                                  DisplayModel displayModel,
                                  boolean blocking,
                                  Set<ErrorModel> errors,
                                  OutputModel output,
                                  OutputModel outputAttributes,
                                  boolean transaction,
                                  boolean requiresConnection,
                                  boolean supportsStreaming,
                                  StereotypeModel stereotype,
                                  List<? extends NestableElementModel> nestedComponents,
                                  MetadataKeyIdModel metadataKeyIdModel,
                                  DeprecationModel deprecationModel)

Deprecated.

OperationModel

public OperationModel(String name,
                      String description,
                      List<ParameterGroupModel> parameterGroupModels,
                      DisplayModel displayModel,
                      boolean blocking,
                      Set<ErrorModel> errors,
                      OutputModel output,
                      OutputModel outputAttributes,
                      boolean transaction,
                      boolean requiresConnection,
                      boolean supportsStreaming,
                      StereotypeModel stereotype,
                      List<? extends NestableElementModel> nestedComponents,
                      MetadataKeyIdModel metadataKeyIdModel,
                      DeprecationModel deprecationModel,
                      TypeResolversInformationModel typeResolversInformationModel,
                      SampleDataProviderModel sampleDataProviderModel)

OperationModel

public OperationModel(String name,
                      String description,
                      List<ParameterGroupModel> parameterGroupModels,
                      DisplayModel displayModel,
                      boolean blocking,
                      Set<ErrorModel> errors,
                      OutputModel output,
                      OutputModel outputAttributes,
                      boolean transaction,
                      boolean requiresConnection,
                      boolean supportsStreaming,
                      StereotypeModel stereotype,
                      List<? extends NestableElementModel> nestedComponents,
                      MetadataKeyIdModel metadataKeyIdModel,
                      DeprecationModel deprecationModel,
                      TypeResolversInformationModel typeResolversInformationModel,
                      SampleDataProviderModel sampleDataProviderModel,
                      Set<String> semanticTerms)

Method Detail

getName

public String getName()

Description copied from interface: ComponentModel

Gets the name of the object

Specified by:

getName in interface ComponentModel

Returns:

the name of the object

getDescription

public String getDescription()

Description copied from interface: ComponentModel

Returns the component's description

Specified by:

getDescription in interface ComponentModel

Returns:

a non blank String

getParameterGroupModels

public List<ParameterGroupModel> getParameterGroupModels()

Specified by:

getParameterGroupModels in interface ParameterizedModel

Returns:

a of groups

getDisplayModel

public Optional<DisplayModel> getDisplayModel()

Specified by:

getDisplayModel in interface ComponentModel

Returns:

An Optional DisplayModel which contains directives about how this model should be displayed in the UI

getErrorModels

public Set<ErrorModel> getErrorModels()

Specified by:

getErrorModels in interface ComponentModel

Returns:

a Set of ErrorModel with the possible errors that the current component could throw.

See Also:

ErrorModel

isBlocking

public boolean isBlocking()

getOutput

public OutputModel getOutput()

getOutputAttributes

public OutputModel getOutputAttributes()

isTransactional

public boolean isTransactional()

requiresConnection

public boolean requiresConnection()

supportsStreaming

public boolean supportsStreaming()

getStereotype

public StereotypeModel getStereotype()

Specified by:

getStereotype in interface ComponentModel

Returns:

The stereotypes which apply to this model

getNestedComponents

public List<? extends NestableElementModel> getNestedComponents()

Specified by:

getNestedComponents in interface ComponentModel

Returns:

the List of components contained by this model

getMetadataKeyIdModel

public Optional<MetadataKeyIdModel> getMetadataKeyIdModel()

getDeprecationModel

public Feature<DeprecationModel> getDeprecationModel()

getTypeResolversInformationModel

public Feature<TypeResolversInformationModel> getTypeResolversInformationModel()

Specified by:

getTypeResolversInformationModel in interface ComponentModel

Returns:

a TypeResolversInformationModel with the information about the resolvers for metadata types.

getSampleDataProviderModel

public Feature<SampleDataProviderModel> getSampleDataProviderModel()

getSemanticTerms

public Set<String> getSemanticTerms()

Description copied from interface: HasSemanticTerms

Returns the semantic terms contained in this model. This could have been a Feature but instead, implementations should handle the cases where coming from an older version by returning an Collections.emptySet()

Specified by:

getSemanticTerms in interface HasSemanticTerms

getParameterGroupModel

public Optional<ParameterGroupModel> getParameterGroupModel(String name)

Specified by:

getParameterGroupModel in interface ParameterizedModel

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object