/AWS1/CL_GURRULEMETADATA¶
Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_ruleid TYPE /AWS1/GURRULEID /AWS1/GURRULEID¶
The ID of the rule.
iv_rulename TYPE /AWS1/GURRULENAME /AWS1/GURRULENAME¶
The name of the rule.
iv_shortdescription TYPE /AWS1/GURSHORTDESCRIPTION /AWS1/GURSHORTDESCRIPTION¶
A short description of the rule.
iv_longdescription TYPE /AWS1/GURLONGDESCRIPTION /AWS1/GURLONGDESCRIPTION¶
A long description of the rule.
it_ruletags TYPE /AWS1/CL_GURRULETAGS_W=>TT_RULETAGS TT_RULETAGS¶
Tags that are associated with the rule.
Queryable Attributes¶
RuleId¶
The ID of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RULEID() |
Getter for RULEID, with configurable default |
ASK_RULEID() |
Getter for RULEID w/ exceptions if field has no value |
HAS_RULEID() |
Determine if RULEID has a value |
RuleName¶
The name of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RULENAME() |
Getter for RULENAME, with configurable default |
ASK_RULENAME() |
Getter for RULENAME w/ exceptions if field has no value |
HAS_RULENAME() |
Determine if RULENAME has a value |
ShortDescription¶
A short description of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHORTDESCRIPTION() |
Getter for SHORTDESCRIPTION, with configurable default |
ASK_SHORTDESCRIPTION() |
Getter for SHORTDESCRIPTION w/ exceptions if field has no va |
HAS_SHORTDESCRIPTION() |
Determine if SHORTDESCRIPTION has a value |
LongDescription¶
A long description of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LONGDESCRIPTION() |
Getter for LONGDESCRIPTION, with configurable default |
ASK_LONGDESCRIPTION() |
Getter for LONGDESCRIPTION w/ exceptions if field has no val |
HAS_LONGDESCRIPTION() |
Determine if LONGDESCRIPTION has a value |
RuleTags¶
Tags that are associated with the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RULETAGS() |
Getter for RULETAGS, with configurable default |
ASK_RULETAGS() |
Getter for RULETAGS w/ exceptions if field has no value |
HAS_RULETAGS() |
Determine if RULETAGS has a value |