@NoImplement public interface ParameterModel extends NamedObject, DescribedObject, EnrichableModel, Typed, HasDisplayModel, HasLayoutModel
Component
or Configuration
A parameter provides a name, a type and a default value.
It can apply either to aConfigurationModel
or a
ComponentModel
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 |
isOverrideFromConfig()
|
boolean |
isRequired()
Whether or not this parameter is required.
|
getName
getDescription
getModelProperties, getModelProperty
getType, hasDynamicType
getDisplayModel
boolean isRequired()
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 requiredboolean isOverrideFromConfig()
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
.
true
, the parameter
will be injected with the same value of the
bound parameter
of the config
that's been associated to the execution.ExpressionSupport getExpressionSupport()
this
parameter has for expressionsExpressionSupport
Object getDefaultValue()
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.
ParameterDslConfiguration getDslConfiguration()
ParameterDslConfiguration
which describes the language which
allows configuring this parameterParameterRole getRole()
ParameterModel
's roleOptional<LayoutModel> getLayoutModel()
LayoutModel.getOrder()
is to be consider relative to the owning
ParameterGroupModel
getLayoutModel
in interface HasLayoutModel
Optional
LayoutModel
which contains directives
about how this parameter should be shown in the UIList<StereotypeModel> getAllowedStereotypes()
List
of StereotypeModel
s that this ParameterModel
should accept values of.Optional<ValueProviderModel> getValueProviderModel()
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.Copyright © 2018. All rights reserved.