Class InvalidParameterException

  • All Implemented Interfaces:
    java.io.Serializable

    public class InvalidParameterException
    extends SubjectAreaCheckedException
    The InvalidParameterException is thrown by the Subject Area OMAS when a parameter is null or an invalid value.
    See Also:
    Serialized Form
    • Constructor Detail

      • InvalidParameterException

        public InvalidParameterException​(ExceptionMessageDefinition messageDefinition,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.String invalidPropertyName,
                                         java.lang.String invalidPropertyValue)
        This is the typical constructor used for creating an InvalidParameterException
        Parameters:
        messageDefinition - content of the message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        invalidPropertyName - invalidPropertyName if there is one
        invalidPropertyValue - invalidPropertyValue if there is one
      • InvalidParameterException

        public InvalidParameterException​(ExceptionMessageDefinition messageDefinition,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.Exception caughtError,
                                         java.lang.String invalidPropertyName,
                                         java.lang.String invalidPropertyValue)
        This is the constructor used for creating an InvalidParameterException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.
        Parameters:
        messageDefinition - content of the message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        caughtError - previous error causing this exception
        invalidPropertyName - invalidPropertyName if there is one
        invalidPropertyValue - invalidPropertyValue if there is one
    • Method Detail

      • getInvalidPropertyName

        public java.lang.String getInvalidPropertyName()
        invalid property name
        Returns:
        invalid property name
      • getInvalidPropertyValue

        public java.lang.String getInvalidPropertyValue()
        invalid property value
        Returns:
        in valid property value
      • getRelatedProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getRelatedProperties()
        Description copied from class: OCFCheckedExceptionBase
        Return any additional properties that were added to the exception to aid diagnosis.
        Overrides:
        getRelatedProperties in class OCFCheckedExceptionBase
        Returns:
        property map
      • setRelatedProperties

        public void setRelatedProperties​(java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)