Class InvalidParameterException

    • Constructor Summary

      Constructors 
      Constructor Description
      InvalidParameterException​(int httpCode, java.lang.String className, java.lang.String actionDescription, java.lang.String errorMessage, java.lang.String errorMessageId, java.lang.String[] errorMessageParameters, java.lang.String systemAction, java.lang.String userAction, java.lang.String caughtErrorClassName, java.lang.String parameterName, java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
      This is the constructor used when receiving an exception from a remote server.
      InvalidParameterException​(int httpCode, java.lang.String className, java.lang.String actionDescription, java.lang.String errorMessage, java.lang.String systemAction, java.lang.String userAction, java.lang.String parameterName)
      Deprecated.
      InvalidParameterException​(int httpCode, java.lang.String className, java.lang.String actionDescription, java.lang.String errorMessage, java.lang.String systemAction, java.lang.String userAction, java.lang.String parameterName, java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
      Deprecated.
      InvalidParameterException​(int httpCode, java.lang.String className, java.lang.String actionDescription, java.lang.String errorMessage, java.lang.String systemAction, java.lang.String userAction, java.lang.Throwable caughtError, java.lang.String parameterName)
      Deprecated.
      InvalidParameterException​(int httpCode, java.lang.String className, java.lang.String actionDescription, java.lang.String errorMessage, java.lang.String systemAction, java.lang.String userAction, java.lang.Throwable caughtError, java.lang.String parameterName, java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
      Deprecated.
      InvalidParameterException​(java.lang.String errorMessage, InvalidParameterException template)
      This is the copy/clone constructor used for creating an exception.
      InvalidParameterException​(java.lang.String errorMessage, OCFCheckedExceptionBase template, java.lang.String parameterName)
      This is the copy/clone constructor used for creating an exception.
      InvalidParameterException​(ExceptionMessageDefinition messageDefinition, java.lang.String className, java.lang.String actionDescription, java.lang.String parameterName)
      This is the typical constructor used for creating an exception.
      InvalidParameterException​(ExceptionMessageDefinition messageDefinition, java.lang.String className, java.lang.String actionDescription, java.lang.String parameterName, java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
      This is the typical constructor used for creating an exception.
      InvalidParameterException​(ExceptionMessageDefinition messageDefinition, java.lang.String className, java.lang.String actionDescription, java.lang.Throwable caughtError, java.lang.String parameterName)
      This is the constructor used for creating an exception that resulted from a previous error.
      InvalidParameterException​(ExceptionMessageDefinition messageDefinition, java.lang.String className, java.lang.String actionDescription, java.lang.Throwable caughtError, java.lang.String parameterName, java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
      This is the constructor used for creating an exception that resulted from a previous error.
      InvalidParameterException​(InvalidParameterException template)
      This is the copy/clone constructor used for creating an exception.
      InvalidParameterException​(OCFCheckedExceptionBase template, java.lang.String parameterName)
      This is the copy/clone constructor used for creating an exception.
    • Constructor Detail

      • InvalidParameterException

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

        public InvalidParameterException​(ExceptionMessageDefinition messageDefinition,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.String parameterName,
                                         java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        This is the typical constructor used for creating an exception.
        Parameters:
        messageDefinition - content of message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        parameterName - name of the invalid parameter if known
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • InvalidParameterException

        public InvalidParameterException​(ExceptionMessageDefinition messageDefinition,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.Throwable caughtError,
                                         java.lang.String parameterName)
        This is the constructor used for creating an exception that resulted from a previous error.
        Parameters:
        messageDefinition - content of message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        caughtError - the error that resulted in this exception.
        parameterName - name of the invalid parameter if known
      • InvalidParameterException

        public InvalidParameterException​(ExceptionMessageDefinition messageDefinition,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.Throwable caughtError,
                                         java.lang.String parameterName,
                                         java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        This is the constructor used for creating an exception that resulted from a previous error.
        Parameters:
        messageDefinition - content of message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        caughtError - the error that resulted in this exception.
        parameterName - name of the invalid parameter if known
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • InvalidParameterException

        public InvalidParameterException​(int httpCode,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.String errorMessage,
                                         java.lang.String errorMessageId,
                                         java.lang.String[] errorMessageParameters,
                                         java.lang.String systemAction,
                                         java.lang.String userAction,
                                         java.lang.String caughtErrorClassName,
                                         java.lang.String parameterName,
                                         java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        This is the constructor used when receiving an exception from a remote server. The values are stored directly in the response object and are passed explicitly to the new exception. Notice that the technical aspects of the exception - such as class name creating the exception are local values so that the implementation of the server is not exposed.
        Parameters:
        httpCode - http response code to use if this exception flows over a REST call
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        errorMessageId - unique identifier for the message
        errorMessageParameters - parameters that were inserted in the message
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        caughtErrorClassName - previous error causing this exception
        parameterName - name of the invalid parameter if known
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • InvalidParameterException

        public InvalidParameterException​(java.lang.String errorMessage,
                                         InvalidParameterException template)
        This is the copy/clone constructor used for creating an exception.
        Parameters:
        errorMessage - message for the exception
        template - object to copy
      • InvalidParameterException

        public InvalidParameterException​(InvalidParameterException template)
        This is the copy/clone constructor used for creating an exception.
        Parameters:
        template - object to copy
      • InvalidParameterException

        public InvalidParameterException​(java.lang.String errorMessage,
                                         OCFCheckedExceptionBase template,
                                         java.lang.String parameterName)
        This is the copy/clone constructor used for creating an exception.
        Parameters:
        errorMessage - message for the exception
        template - object to copy
        parameterName - name of invalid parameter
      • InvalidParameterException

        public InvalidParameterException​(OCFCheckedExceptionBase template,
                                         java.lang.String parameterName)
        This is the copy/clone constructor used for creating an exception.
        Parameters:
        template - object to copy
        parameterName - name of invalid parameter
      • InvalidParameterException

        @Deprecated
        public InvalidParameterException​(int httpCode,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.String errorMessage,
                                         java.lang.String systemAction,
                                         java.lang.String userAction,
                                         java.lang.String parameterName)
        Deprecated.
        This is the typical constructor used for creating an exception.
        Parameters:
        httpCode - http response code to use if this exception flows over a rest call
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        parameterName - name of the invalid parameter if known
      • InvalidParameterException

        @Deprecated
        public InvalidParameterException​(int httpCode,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.String errorMessage,
                                         java.lang.String systemAction,
                                         java.lang.String userAction,
                                         java.lang.String parameterName,
                                         java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        Deprecated.
        This is the typical constructor used for creating an exception.
        Parameters:
        httpCode - http response code to use if this exception flows over a rest call
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        parameterName - name of the invalid parameter if known
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • InvalidParameterException

        @Deprecated
        public InvalidParameterException​(int httpCode,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.String errorMessage,
                                         java.lang.String systemAction,
                                         java.lang.String userAction,
                                         java.lang.Throwable caughtError,
                                         java.lang.String parameterName)
        Deprecated.
        This is the constructor used for creating an exception that resulted from a previous error.
        Parameters:
        httpCode - http response code to use if this exception flows over a rest call
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        caughtError - the error that resulted in this exception.
        parameterName - name of the invalid parameter if known
      • InvalidParameterException

        @Deprecated
        public InvalidParameterException​(int httpCode,
                                         java.lang.String className,
                                         java.lang.String actionDescription,
                                         java.lang.String errorMessage,
                                         java.lang.String systemAction,
                                         java.lang.String userAction,
                                         java.lang.Throwable caughtError,
                                         java.lang.String parameterName,
                                         java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        Deprecated.
        This is the constructor used for creating an exception that resulted from a previous error.
        Parameters:
        httpCode - http response code to use if this exception flows over a rest call
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        caughtError - the error that resulted in this exception.
        parameterName - name of the invalid parameter if known
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
    • Method Detail

      • getParameterName

        public java.lang.String getParameterName()
        Return the invalid parameter's name, if known.
        Returns:
        string name
      • toString

        public java.lang.String toString()
        JSON-style toString
        Overrides:
        toString in class OCFCheckedExceptionBase
        Returns:
        string of property names and values for this enum
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Return comparison result based on the content of the properties.
        Overrides:
        equals in class OCFCheckedExceptionBase
        Parameters:
        objectToCompare - test object
        Returns:
        result of comparison