org.mule.runtime.api.meta.model.parameter

Interface ParameterModel

All Superinterfaces:

DeprecableModel, DescribedObject, EnrichableModel, HasDisplayModel, HasLayoutModel, NamedObject, Typed

@NoImplement
public interface ParameterModel
extends NamedObject, DescribedObject, EnrichableModel, Typed, HasDisplayModel, HasLayoutModel, DeprecableModel

A parameter of a Component or Configuration

A parameter provides a name, a type and a default value.

It can apply either to a ConfigurationModel or a ComponentModel

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
List<StereotypeModel>	getAllowedStereotypes()
Object	getDefaultValue() The default value for this parameter.
ParameterDslConfiguration	getDslConfiguration()
ExpressionSupport	getExpressionSupport() The level of support this parameter has for expressions
Optional<LayoutModel>	getLayoutModel() The value of LayoutModel.getOrder() is to be consider relative to the owning ParameterGroupModel
ParameterRole	getRole()
Optional<ValueProviderModel>	getValueProviderModel()
boolean	isComponentId() Whether or not this ParameterModel is declared as ID of the owning ComponentModel.
boolean	isOverrideFromConfig() Whether or not this parameter is bound to a ParameterModel of the same name and type that exists in the config associated to the container of this parameter.
boolean	isRequired() Whether or not this parameter is required.

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.EnrichableModel

getModelProperties, getModelProperty

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

getType, hasDynamicType

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

getDisplayModel

Methods inherited from interface org.mule.runtime.api.meta.model.deprecated.DeprecableModel

getDeprecationModel, isDeprecated

Method Detail

isRequired

boolean isRequired()

Whether or not this parameter is required. This method is exclusive with getDefaultValue() in the sense that a required parameter cannot have a default value. At the same time, if the parameter has a default value, then it makes no sense to consider it as required

Returns:

a boolean value saying if this parameter is required or not

isOverrideFromConfig

boolean isOverrideFromConfig()

Whether or not this parameter is bound to a ParameterModel of the same name and type that exists in the config associated to the container of this parameter.
When true, the parameter will be injected with the same value of the bound parameter of the config that's been associated to the execution.

Returns:

a boolean value saying if this parameter acts as an override for a parameter defined in a config.

getExpressionSupport

ExpressionSupport getExpressionSupport()

The level of support this parameter has for expressions

Returns:

a ExpressionSupport

getDefaultValue

Object getDefaultValue()

The default value for this parameter. It might be an expression if getExpressionSupport() returns ExpressionSupport.REQUIRED or ExpressionSupport.SUPPORTED.

This method is exclusive with isRequired(). Check that method's comments for more information on the semantics of this two methods.

Returns:

the default value

getDslConfiguration

ParameterDslConfiguration getDslConfiguration()

Returns:

A ParameterDslConfigurationwhich describes the language which allows configuring this parameter

getRole

ParameterRole getRole()

Returns:

this ParameterModel's role

getLayoutModel

Optional<LayoutModel> getLayoutModel()

The value of LayoutModel.getOrder() is to be consider relative to the owning ParameterGroupModel

Specified by:

getLayoutModel in interface HasLayoutModel

Returns:

An Optional LayoutModel which contains directives about how this parameter should be shown in the UI

getAllowedStereotypes

List<StereotypeModel> getAllowedStereotypes()

Returns:

a List of StereotypeModels that this ParameterModel should accept values of.

getValueProviderModel

Optional<ValueProviderModel> getValueProviderModel()

Returns:

A ValueProviderModel to communicate if the this parameter model is capable to provide values. an Optional.empty() if there is no model associate to this parameter.

isComponentId

boolean isComponentId()

Whether or not this ParameterModel is declared as ID of the owning ComponentModel. Being a Component ID means that the value associated to the annotated parameter can be used to reference the component in a mule application uniquely across all the instances of the same ComponentModel. When used on a global element of the application, then this Component ID serves as a global ID in the application.

An example of a ComponentModel ID is the name parameter of a config element.

Restrictions apply in order for a ParameterModel to be a ComponentModel ID:

• Only one parameter can be component ID for any given ComponentModel
• Only required parameters serve as Component ID
• The parameter's type has to be String
• The parameter's expression support will be ExpressionSupport.NOT_SUPPORTED, so no dynamic values are allowed
• ParameterRole.CONTENT qualifier is not allowed for a Component ID
• Text qualifier is not allowed for a Component ID
• Query qualifier is not allowed for a Component ID
• Defaulting to a ConfigOverride is not allowed for a Component ID since it describes the ID of each individual component and no common global value should be used as ID

Returns:

true if this ParameterModel is a ComponentModel ID.