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

Interface ComponentModel

All Superinterfaces:

HasSemanticTerms, ParameterizedModel

All Known Implementing Classes:

ConstructModel, OperationModel, SourceModel

public interface ComponentModel
extends ParameterizedModel, HasSemanticTerms

A definition of a component in an ExtensionModel. This model groups all the common contracts between extension components like OperationModel, SourceModel, etc.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the component's description
Optional<DisplayModel>	getDisplayModel()
Set<ErrorModel>	getErrorModels()
String	getName() Gets the name of the object
List<? extends NestableElementModel>	getNestedComponents()
StereotypeModel	getStereotype()
Feature<TypeResolversInformationModel>	getTypeResolversInformationModel()

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

getAllParameterModels, getParameterGroupModel, getParameterGroupModels

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

getSemanticTerms

Method Detail

getName

String getName()

Gets the name of the object

Returns:

the name of the object

getDescription

String getDescription()

Returns the component's description

Returns:

a non blank String

getNestedComponents

List<? extends NestableElementModel> getNestedComponents()

Returns:

the List of components contained by this model

getStereotype

StereotypeModel getStereotype()

Returns:

The stereotypes which apply to this model

getDisplayModel

Optional<DisplayModel> getDisplayModel()

Returns:

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

getErrorModels

Set<ErrorModel> getErrorModels()

Returns:

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

See Also:

ErrorModel

getTypeResolversInformationModel

Feature<TypeResolversInformationModel> getTypeResolversInformationModel()

Returns:

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