|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.are.xml.rules.Rule
com.ibm.ibmi.are.xml.rules.ptf.PtfRule
com.ibm.ibmi.are.xml.rules.ptf.GroupPtfLevelRule
public class GroupPtfLevelRule
Rule class that verifies the PTF group level
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright for class bytecode |
static java.lang.String |
GROUP_PTF_LEVEL_RULE_TYPE_MINIMUM
Verify that the PTF group level meets the minimum requirement |
static java.lang.String |
GROUP_PTF_LEVEL_RULE_TYPE_RECOMMENDED
Verify that the PTF group level meets the recommended requirement |
Fields inherited from class com.ibm.are.xml.rules.Rule |
---|
MAP_ITEM_CHECK_CLASS, MAP_ITEM_CHECK_OBJECT, MAP_ITEM_CHECK_TYPE, MAP_ITEM_ERROR_LEVEL, MAP_ITEM_EXPECTED_VALUE, MAP_ITEM_MATCH_CASE |
Constructor Summary | |
---|---|
GroupPtfLevelRule(java.util.Map ruleInfo)
The API constructor for this class. |
|
GroupPtfLevelRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo,
java.lang.String group,
java.lang.String level,
java.lang.String type)
This constructor is for internal class use only. |
Method Summary | |
---|---|
boolean |
run(com.ibm.are.plugin.Plugin plugin)
Runs the rule, which performs the check/verification implemented by that rule. |
Methods inherited from class com.ibm.ibmi.are.xml.rules.ptf.PtfRule |
---|
findPtfGroup, getPtfName, setPtfName |
Methods inherited from class com.ibm.are.xml.rules.Rule |
---|
getNodeInfo, report, report |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String GROUP_PTF_LEVEL_RULE_TYPE_MINIMUM
public static final java.lang.String GROUP_PTF_LEVEL_RULE_TYPE_RECOMMENDED
Constructor Detail |
---|
public GroupPtfLevelRule(java.util.Map ruleInfo)
ruleInfo
- Any object that implements the java.util.Map
interface.
This map contains a set of key/value pairs which specify all of the
information needed by this rule class to perform its check.
Rule Info Map Contents
The table below describes all items, both required and optional, that are allowed to be
in the ruleInfo
map passed to the API constructor.
Key | Description | Required | Valid Values | Default Value |
---|---|---|---|---|
name | The group PTF name/number | Yes | Must be a valid IBM i group PTF number. Examples:
|
N/A |
level | The expected level for the specified group PTF | Yes | A number greater than zero | N/A |
type | The type of level check to perform for the specified group PTF | Yes |
|
N/A |
errorLevel | Specifies the severity level a problem is reported at for this check. If the comparison between the
expected and actual values is not successful, which means the comparison result was false ,
a problem is reported. The severity of the reported problem is determined by the error level. |
No |
|
error |
public GroupPtfLevelRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo, java.lang.String group, java.lang.String level, java.lang.String type)
Method Detail |
---|
public boolean run(com.ibm.are.plugin.Plugin plugin)
run
in class Rule
plugin
- The plugin for which the rule is being run for.
true
if the verification was successful and no problems were found.
false
if the verification resulted in a problem being found and reported.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |