com.ibm.ibmi.are.xml.rules.userprofile
Class LanguageIdRule

java.lang.Object
  extended by com.ibm.are.xml.rules.Rule
      extended by com.ibm.ibmi.are.xml.rules.userprofile.UserProfileRule
          extended by com.ibm.ibmi.are.xml.rules.userprofile.LanguageIdRule

public class LanguageIdRule
extends UserProfileRule

Rule class that verifies the language ID field of a user profile

Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
 
Fields inherited from class com.ibm.ibmi.are.xml.rules.userprofile.UserProfileRule
MAP_ITEM_NAME
 
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
LanguageIdRule(java.util.Map ruleInfo)
          The API constructor for this class.
LanguageIdRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo, java.lang.String name, Check checkOperation)
          This constructor is for internal class use only.
 
Method Summary
 java.lang.Object getActualValue(com.ibm.as400.access.User theUser)
          Retrieves the actual value for the user profile field that is being verified.
 java.lang.String getFieldName()
          Retrieves the descriptive name of the user profile field
 
Methods inherited from class com.ibm.ibmi.are.xml.rules.userprofile.UserProfileRule
getUser, getUserName, run, setUserName
 
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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values
Constructor Detail

LanguageIdRule

public LanguageIdRule(java.util.Map ruleInfo)
The API constructor for this class. This API can be used to leverage the capabilities of this rule class from within any Application Runtime Expert plugin.

Parameters:
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 user profile name. Yes Any valid IBM i user profile name N/A
checkClass The data type (class) of the expected and actual values. No
  • string
  • numeric
string
checkType The type of check to perform between the expected and actual values. Or said another way, this value specifies how the expected and actual values are compared. The check type is related to the check class, so care must be taken when specifying these two values. For example, a check type of inRange is valid only if the check class is set to numeric. No For a list of all supported check types, see the com.ibm.are.xml.check.Check class documentation equals
expectedValue The expected value is the value that is used to compare against, or check, the actual value. Yes The only limitations on this value is that it cannot be null or an empty, zero length string. N/A
matchCase Specifies whether or not character case is honored when performing string comparisons. This value is only applicable when the check class value is set to string, and is ignored for any other check class. No
  • true
  • false

A value of true means that case is honored when performing string comparisons. A value of false means that case is ignored when performing string comparisons.

false
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
  • warning
  • info
error

LanguageIdRule

public LanguageIdRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo,
                      java.lang.String name,
                      Check checkOperation)
This constructor is for internal class use only. New instances of this class should only be created using the API constructor for this class.

Method Detail

getActualValue

public java.lang.Object getActualValue(com.ibm.as400.access.User theUser)
Retrieves the actual value for the user profile field that is being verified.

Specified by:
getActualValue in class UserProfileRule
Parameters:
theUser - The user profile to retrieve the actual value from
Returns:
The actual value for the field that is being verified

getFieldName

public java.lang.String getFieldName()
Retrieves the descriptive name of the user profile field

Specified by:
getFieldName in class UserProfileRule
Returns:
The descriptive name of the user profile field