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

Interface ParameterGroupModel

All Superinterfaces:

DescribedObject, EnrichableModel, HasDisplayModel, HasLayoutModel, NamedObject

public interface ParameterGroupModel
extends NamedObject, DescribedObject, HasDisplayModel, HasLayoutModel, EnrichableModel

A group is a logical way to display one or more parameters together. If no group is specified then DEFAULT_GROUP_NAME is used by default.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADVANCED Group name for parameters that are considered for advanced usage.
static String	CONNECTION Group name for parameters that are considered to be part of a connection configuration.
static String	DEFAULT_GROUP_NAME Group name for parameters that are considered for general purposes and shouldn't belong to a particular group.
static String	OUTPUT Group name for parameters that are for controling the opertion's output

Method Summary

Modifier and Type	Method and Description
List<ExclusiveParametersModel>	getExclusiveParametersModels() Returns a list of ExclusiveParametersModel which describe mutual exclusions between the parameters
Optional<ParameterModel>	getParameter(String name) Returns the parameterModel with the given name if one is present.
List<ParameterModel>	getParameterModels() Returns the parameterModels available for this group
boolean	isShowInDsl()

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.display.HasLayoutModel

getLayoutModel

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

getModelProperties, getModelProperty

Field Detail

DEFAULT_GROUP_NAME

static final String DEFAULT_GROUP_NAME

Group name for parameters that are considered for general purposes and shouldn't belong to a particular group.

See Also:

Constant Field Values

ADVANCED

static final String ADVANCED

Group name for parameters that are considered for advanced usage.

See Also:

Constant Field Values

OUTPUT

static final String OUTPUT

Group name for parameters that are for controling the opertion's output

See Also:

Constant Field Values

CONNECTION

static final String CONNECTION

Group name for parameters that are considered to be part of a connection configuration.

See Also:

Constant Field Values

Method Detail

getParameterModels

List<ParameterModel> getParameterModels()

Returns the parameterModels available for this group

Returns:

a immutable List with ParameterModel instances. It will never be empty

getExclusiveParametersModels

List<ExclusiveParametersModel> getExclusiveParametersModels()

Returns a list of ExclusiveParametersModel which describe mutual exclusions between the parameters

Returns:

a List of ExclusiveParametersModel

getParameter

Optional<ParameterModel> getParameter(String name)

Returns the parameterModel with the given name if one is present.

Returns:

the parameterModel with the given name or Optional.empty() if none is found.

isShowInDsl

boolean isShowInDsl()

Returns:

true if this group should be represented inline as a child element in the DSL