Class UserPropertyException

  • All Implemented Interfaces:
    java.io.Serializable

    public class UserPropertyException
    extends SemanticException
    Reports an error during a user property operation.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      UserPropertyException​(org.eclipse.birt.report.model.core.DesignElement obj, java.lang.String name, java.lang.String errCode)
      Constructor.
      UserPropertyException​(org.eclipse.birt.report.model.core.DesignElement obj, java.lang.String name, java.lang.String errCode, ModelException cause, java.lang.String[] args)
      Constructor.
      UserPropertyException​(org.eclipse.birt.report.model.core.DesignElement obj, java.lang.String name, java.lang.String errCode, org.eclipse.birt.report.model.metadata.MetaDataException cause)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLocalizedMessage()  
      java.lang.String getPropertyName()
      Gets the name of the property that caused the problem.
      • Methods inherited from class org.eclipse.birt.core.exception.BirtException

        getErrorCode, getLocalizedMessage, getPluginId, getSeverity, setSeverity
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • propertyName

        protected java.lang.String propertyName
        The name of the user property affected.
      • DESIGN_EXCEPTION_NAME_REQUIRED

        public static final java.lang.String DESIGN_EXCEPTION_NAME_REQUIRED
        Error code indicating the use property definition is missing name, while it must have a name.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_DUPLICATE_NAME

        public static final java.lang.String DESIGN_EXCEPTION_DUPLICATE_NAME
        Error code indicating the new user property duplicates an existing property name.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_INVALID_TYPE

        public static final java.lang.String DESIGN_EXCEPTION_INVALID_TYPE
        Error code indicating the user property type is invalid.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_INVALID_DEFINITION

        public static final java.lang.String DESIGN_EXCEPTION_INVALID_DEFINITION
        Error code indicating the user property definition is invalid.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_MISSING_CHOICES

        public static final java.lang.String DESIGN_EXCEPTION_MISSING_CHOICES
        Error code indicating the user property type is choice, but no choice is defined.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_INVALID_DISPLAY_ID

        public static final java.lang.String DESIGN_EXCEPTION_INVALID_DISPLAY_ID
        Error code indicating the display name ID is provided, and display name can not be found.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_NOT_FOUND

        public static final java.lang.String DESIGN_EXCEPTION_NOT_FOUND
        Error code indicating the user property definition is not found.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_USER_PROP_DISALLOWED

        public static final java.lang.String DESIGN_EXCEPTION_USER_PROP_DISALLOWED
        Error code indicating the element is not allowed to have user property.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_CHOICE_VALUE_REQUIRED

        public static final java.lang.String DESIGN_EXCEPTION_CHOICE_VALUE_REQUIRED
        Error code indicating the value of the user choice is missing.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_CHOICE_NAME_REQUIRED

        public static final java.lang.String DESIGN_EXCEPTION_CHOICE_NAME_REQUIRED
        Error code indicating the name of the user choice is missing.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_INVALID_CHOICE_VALUE

        public static final java.lang.String DESIGN_EXCEPTION_INVALID_CHOICE_VALUE
        Error code indicating the choice value is invalid for the user property type, which is not choice.
        See Also:
        Constant Field Values
      • DESIGN_EXCEPTION_INVALID_DEFAULT_VALUE

        public static final java.lang.String DESIGN_EXCEPTION_INVALID_DEFAULT_VALUE
        Error code indicating the default value is invalid for the user property type.
        See Also:
        Constant Field Values
    • Constructor Detail

      • UserPropertyException

        public UserPropertyException​(org.eclipse.birt.report.model.core.DesignElement obj,
                                     java.lang.String name,
                                     java.lang.String errCode)
        Constructor.
        Parameters:
        obj - the element to be changed.
        name - the name of the user property.
        errCode - what went wrong.
      • UserPropertyException

        public UserPropertyException​(org.eclipse.birt.report.model.core.DesignElement obj,
                                     java.lang.String name,
                                     java.lang.String errCode,
                                     org.eclipse.birt.report.model.metadata.MetaDataException cause)
        Constructor.
        Parameters:
        obj - the element to be changed
        name - the name of the user property
        errCode - the error code
        cause - the nested exception
      • UserPropertyException

        public UserPropertyException​(org.eclipse.birt.report.model.core.DesignElement obj,
                                     java.lang.String name,
                                     java.lang.String errCode,
                                     ModelException cause,
                                     java.lang.String[] args)
        Constructor.
        Parameters:
        obj - the element to be changed
        name - the name of the user property
        errCode - the error code
        cause - the nested exception
        args - argument array used for error message
    • Method Detail

      • getPropertyName

        public java.lang.String getPropertyName()
        Gets the name of the property that caused the problem.
        Returns:
        the property name.