Package com.documentum.fc.common

Class DfValidationException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.documentum.fc.common.DfException
com.documentum.fc.common.DfValidationException
All Implemented Interfaces:
IDfException, Serializable
public class DfValidationException extends DfException
DfValidationException will be thrown when a validation rule is violated
See Also:

  • Field Details

    • DF_VALIDATION_ERROR

      public static final int DF_VALIDATION_ERROR
      See Also:

    • DF_ATTR_RULES_VIOLATED

      public static final int DF_ATTR_RULES_VIOLATED
      See Also:

    • DF_OBJ_RULES_VIOLATED

      public static final int DF_OBJ_RULES_VIOLATED
      See Also:

    • DFE_ATTR_NAME

      public static final String DFE_ATTR_NAME
      The property name for the attribute violating the attribute validation rules. The data type of this property is String. The null value will be represented by an empty string ("").
      See Also:

    • DFE_ATTR_VALUE

      public static final String DFE_ATTR_VALUE
      The property name for the value of attribute violating the attribute validation rules. The data type of this property is String. The null value will be represented by an empty string ("").
      See Also:

    • DFE_ATTRS_NAMES

      public static final String DFE_ATTRS_NAMES
      The property name for the list of attributes violating the object validation rules. The data type of this property is IDfList. The list is a list of strings.
      See Also:

    • DFE_ATTRS_VALUES

      public static final String DFE_ATTRS_VALUES
      The property name for the list of values for the attributes violating the object validation rules. The data type of this property is IDfList. The list is a list of lists where each list contains those values for the corresponding attribute provided in the "attrNames" property. In other words, if the attrNames property is set and its value is the list { "object_name", "keywords" }, the value of this property would be a list containing two lists. It value might look like { { "Doc Name" }, { "foo", "bar" } }.
      See Also:

    • DFE_ATTR_RULES_VIOLATED

      public static final String DFE_ATTR_RULES_VIOLATED
      The property name for the flag that indicates whether attribute rules were violated or not. The data type of this property is boolean.
      See Also:

    • DFE_OBJ_RULES_VIOLATED

      public static final String DFE_OBJ_RULES_VIOLATED
      The property name for the flag that indicates whether object rules were violated or not. The data type of this property is boolean.
      See Also:

    • DFE_CONSTRAINT_ERR_MSG

      public static final String DFE_CONSTRAINT_ERR_MSG
      The property name for the attribute or object constraint error message. The value of this property will be the error message specified by the REPORT clause of the relevant constraint specification used in the CREATE/ALTER TYPE query. This clause is optional so it may be an empty string. The data type of this property is String.
      See Also:

    • DFE_MAX_LENGTH

      public static final String DFE_MAX_LENGTH
      Property name for the maximum string length. This property gets set when DM_VALIDATION_E_EXCESS_LEN validation exceptions are thrown. The value is the maximum string length allowed for that attribute (in bytes). The data type of this property is int.
      See Also:

    • DFE_DATA_TYPE

      public static final String DFE_DATA_TYPE
      Property name for the attribute data type. This property is set when DM_VALIDATION_E_DATATYPE validation exceptions are thrown. The value is the integer constant (0-5) representing the attribute's expected type (see constant values defined in IDfAttr or described in the server manual). The data type of this property is int.
      See Also:

    • DFE_FORMAT_PATTERN

      public static final String DFE_FORMAT_PATTERN
      Property name for the attribute's pattern mask. This property is set when DM_VALIDATION_E_FORMAT validation exceptions are thrown. The value is the format mask used to validate the value (e.g.: "UUU-##"). The data type of this property is String.
      See Also:

    • DFE_VALUE_LIST

      public static final String DFE_VALUE_LIST
      Property name for the list containing the valid values for the attribute. This property is set when DM_VALIDATION_E_USE_VALUE_ASST validation exceptions are thrown. The values are the string values from the value assistance list. (This exception is thrown only when the value assistance is marked as COMPLETE and the value is not one of the values in that list.) The data type of this property is IDfList. The list is a list of strings.
      See Also:

  • Constructor Details

    • DfValidationException

      public DfValidationException(String strKey, String[] args)

    • DfValidationException

      public DfValidationException(String strKey, String[] args, Throwable t)

    • DfValidationException

      public DfValidationException(String strKey, IDfValue value)

    • DfValidationException

      public DfValidationException(String strKey, String strAttrName, IDfValue value, String msg)

    • DfValidationException

      public DfValidationException(String strKey, IDfList attrs, IDfList values, String msg)

  • Method Details

    • getAttrName

      public String getAttrName()

    • getAttrValue

      public String getAttrValue()

    • getAttrsNames

      public IDfList getAttrsNames()

    • getAttrsValues

      public IDfList getAttrsValues()

    • setAttrName

      public void setAttrName(String attrName)

    • setAttrValue

      public void setAttrValue(IDfValue attrValue)

    • setAttrsNames

      public void setAttrsNames(IDfList attrNameList)

    • setAttrsValues

      public void setAttrsValues(IDfList attrValueList)

    • setProperty

      public void setProperty(String strName, String value)

    • setProperty

      public void setProperty(String strName, int value)

    • setProperty

      public void setProperty(String strName, IDfList value)