org.kuali.rice.krms.framework.type

Enum ValidationRuleType

java.lang.Object

java.lang.Enum<ValidationRuleType>

org.kuali.rice.krms.framework.type.ValidationRuleType

All Implemented Interfaces:

Serializable, Comparable<ValidationRuleType>, org.kuali.rice.core.api.mo.common.Coded

public enum ValidationRuleType
extends Enum<ValidationRuleType>
implements org.kuali.rice.core.api.mo.common.Coded

enum used to specify the validationRule type to be specified in the vended ValidationRules. INVALID VALID

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID use this flag with the static factory to get a ValidationRuleTypeService} that creates warning validationRules.
VALID use this flag with the static factory to get a ValidationRuleTypeService} that creates error validationRules.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	VALID_TYPE_CODES Set of valid type codes

Method Summary

Modifier and Type	Method and Description
static ValidationRuleType	fromCode(String code) for each type, check the input with the uppercase version of the type code, and returns any match.
static ValidationRuleType	fromString(String s) for each type, check the input with the lowercase version of the type name, and returns any match.
String	getCode() The code value for this object.
String	toString()
static ValidationRuleType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ValidationRuleType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INVALID

public static final ValidationRuleType INVALID

use this flag with the static factory to get a ValidationRuleTypeService} that creates warning validationRules.

VALID

public static final ValidationRuleType VALID

use this flag with the static factory to get a ValidationRuleTypeService} that creates error validationRules.

Field Detail

VALID_TYPE_CODES

public static final Set<String> VALID_TYPE_CODES

Set of valid type codes

Method Detail

values

public static ValidationRuleType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ValidationRuleType c : ValidationRuleType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ValidationRuleType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ValidationRuleType>

fromString

public static ValidationRuleType fromString(String s)

for each type, check the input with the lowercase version of the type name, and returns any match.

Parameters:

s - the type to retrieve

Returns:

the type, or null if a match is not found.

fromCode

public static ValidationRuleType fromCode(String code)

for each type, check the input with the uppercase version of the type code, and returns any match.

Parameters:

code - the type to retrieve

Returns:

the type, or null if a match is not found.

getCode

public String getCode()

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface org.kuali.rice.core.api.mo.common.Coded

Returns:

the code value for this object.