EntityParameter
This page provides generated reference documentation for the EntityParameter data model.
A Parameter basically contains the criteria the Provider needs to select the required data
Overview
| Property | Summary |
|---|---|
| customProperties | — |
| description | Short technical description of the model in plain text. |
| documentation | Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different… |
| expose | Indicates whether the parameter can be overridden by a dependency field, or whether it exists only in its own entity. |
| mandatory | Indicates whether this field is mandatory and the value of this field must be set. |
| title | Singular title of this parameter, e.g. Person |
| valueProcess | Process that is executed when the value of the parameter is requested. In this process, everything can be returned. |
customProperties
Type: CustomProperties
description
Type: String
Short technical description of the model in plain text.
documentation
Type: String
Contains the documentation of the data model in the popular AsciiDoc format (.adoc).
The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that they designed.
You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.
<!--VSCODE_ONLY-->
expose
Type: Boolean
Indicates whether the parameter can be overridden by a dependency field, or whether it exists only in its own entity.
mandatory
Type: Boolean
Indicates whether this field is mandatory and the value of this field must be set.
title
Type: String
Constraints: Verification: TITLE_LENGTH
Singular title of this parameter, e.g. Person
valueProcess
Type: String
Process that is executed when the value of the parameter is requested. In this process, everything can be returned.