Variant parameter (automation interface)
A Variant Parameter object is used to define the variability parameter of a Variant or Requires Dependency object.
A Variant Parameter object is not shown in Modeler as an item, but the attributes of a Variant Parameter object are shown on the Property Pages of the owning Variant or Requires Dependency.
A Variant or Dependency object is linked to a Variant Parameter through the Parameter association.
ATTRIBUTES:
In addition to the
common attributes.
Parameter Type
A string that specifies the type of the variability parameter:
• 0 means short
• 1 mean long.
• 2 means Boolean
• 3 means string
• 4 means enum
Default Boolean
A string that specifies the default value of the variability parameter when the Parameter Type attribute is set to 2 (Boolean).
This attribute applies only when the Has Default attribute is set to TRUE.
Access is read/write.
Default Long
A string that specifies the default value of the variability parameter when the Parameter Type attribute is set to 1 (long).
This attribute applies only when the Has Default attribute is set to TRUE.
Access is read/write.
Default Short
A string that specifies the default value of the variability parameter when the Parameter Type attribute is set to 0 (short).
This attribute applies only when the Has Default attribute is set to TRUE.
Access is read/write.
Default String
A string that specifies the default value of the variability parameter when the Parameter Type attribute is set to 3 (string) or 4 (enum).
This attribute applies only when the Has Default attribute is set to TRUE.
Access is read/write.
Enum Literals
A string that specifies the permitted values of an enumeration variability parameter.
This attribute applies only when the Parameter Type is set to 4 (enum).
Access is read/write.
Has Default
A string that specifies whether the variability parameter has a default value. Possible values are TRUE or FALSE.
The default value is specified through the Default Boolean, Default Long, Default Short or Default String attribute.
Access is read/write.
Has Max String Length
A string that specifies whether a variability parameter has a maximum string length. Possible values are TRUE or FALSE.
This attribute applies only when the Parameter Type is set to 3 (string).
This Max String Length attribute specifies the maximum length.
Access is read/write.
Is Editable
A string that specifies whether the value of the variability parameter is editable through the Decision Set Editor or Variant Selector. Possible values are TRUE or FALSE.
Access is read/write.
Max String Length
A string that specifies the maximum string length of a variability parameter.
This attribute applies only when the Parameter Type is set to 3 (string) and the Has Max String Length attribute is set to TRUE.
Access is read/write.
Multiline Text
A string that specifies whether a variability parameter supports multiline text. Possible values are TRUE or FALSE.
This attribute applies only when the Parameter Type is set to 3 (string).
Access is read/write.
Range Start
A string that specifies the minimum value of a variability parameter.
This attribute applies only when the Parameter Type is set to 0 (short) or 1 (long).
Access is read/write.
Range End
A string that specifies the maximum value of a variability parameter.
This attribute applies only when the Parameter Type is set to 0 (short) or 1 (long).
Access is read/write.
ASSOCIATIONS:
In addition to the
common associationsRelationship to a Script object that specifies the Derivation Script for a variability parameter.
Multiplicity is 0-1, access is read/write.