/AWS1/CL_SCGPARAMETERCNSTRNTS¶
The constraints that the administrator has put on the parameter.
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
it_allowedvalues
TYPE /AWS1/CL_SCGALLOWEDVALUES_W=>TT_ALLOWEDVALUES
TT_ALLOWEDVALUES
¶
The values that the administrator has allowed for the parameter.
iv_allowedpattern
TYPE /AWS1/SCGSTRING
/AWS1/SCGSTRING
¶
A regular expression that represents the patterns that allow for
String
types. The pattern must match the entire parameter value provided.
iv_constraintdescription
TYPE /AWS1/SCGSTRING
/AWS1/SCGSTRING
¶
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of
[A-Za-z0-9]+
displays the following error message when the user specifies an invalid value:
Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
iv_maxlength
TYPE /AWS1/SCGSTRING
/AWS1/SCGSTRING
¶
An integer value that determines the largest number of characters you want to allow for
String
types.
iv_minlength
TYPE /AWS1/SCGSTRING
/AWS1/SCGSTRING
¶
An integer value that determines the smallest number of characters you want to allow for
String
types.
iv_maxvalue
TYPE /AWS1/SCGSTRING
/AWS1/SCGSTRING
¶
A numeric value that determines the largest numeric value you want to allow for
Number
types.
iv_minvalue
TYPE /AWS1/SCGSTRING
/AWS1/SCGSTRING
¶
A numeric value that determines the smallest numeric value you want to allow for
Number
types.
Queryable Attributes¶
AllowedValues¶
The values that the administrator has allowed for the parameter.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ALLOWEDVALUES() |
Getter for ALLOWEDVALUES, with configurable default |
ASK_ALLOWEDVALUES() |
Getter for ALLOWEDVALUES w/ exceptions if field has no value |
HAS_ALLOWEDVALUES() |
Determine if ALLOWEDVALUES has a value |
AllowedPattern¶
A regular expression that represents the patterns that allow for
String
types. The pattern must match the entire parameter value provided.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ALLOWEDPATTERN() |
Getter for ALLOWEDPATTERN, with configurable default |
ASK_ALLOWEDPATTERN() |
Getter for ALLOWEDPATTERN w/ exceptions if field has no valu |
HAS_ALLOWEDPATTERN() |
Determine if ALLOWEDPATTERN has a value |
ConstraintDescription¶
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of
[A-Za-z0-9]+
displays the following error message when the user specifies an invalid value:
Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CONSTRAINTDESCRIPTION() |
Getter for CONSTRAINTDESCRIPTION, with configurable default |
ASK_CONSTRAINTDESCRIPTION() |
Getter for CONSTRAINTDESCRIPTION w/ exceptions if field has |
HAS_CONSTRAINTDESCRIPTION() |
Determine if CONSTRAINTDESCRIPTION has a value |
MaxLength¶
An integer value that determines the largest number of characters you want to allow for
String
types.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MAXLENGTH() |
Getter for MAXLENGTH, with configurable default |
ASK_MAXLENGTH() |
Getter for MAXLENGTH w/ exceptions if field has no value |
HAS_MAXLENGTH() |
Determine if MAXLENGTH has a value |
MinLength¶
An integer value that determines the smallest number of characters you want to allow for
String
types.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MINLENGTH() |
Getter for MINLENGTH, with configurable default |
ASK_MINLENGTH() |
Getter for MINLENGTH w/ exceptions if field has no value |
HAS_MINLENGTH() |
Determine if MINLENGTH has a value |
MaxValue¶
A numeric value that determines the largest numeric value you want to allow for
Number
types.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MAXVALUE() |
Getter for MAXVALUE, with configurable default |
ASK_MAXVALUE() |
Getter for MAXVALUE w/ exceptions if field has no value |
HAS_MAXVALUE() |
Determine if MAXVALUE has a value |
MinValue¶
A numeric value that determines the smallest numeric value you want to allow for
Number
types.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MINVALUE() |
Getter for MINVALUE, with configurable default |
ASK_MINVALUE() |
Getter for MINVALUE w/ exceptions if field has no value |
HAS_MINVALUE() |
Determine if MINVALUE has a value |