java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
    - - org.odpi.openmetadata.repositoryservices.ffdc.exception.OMRSCheckedExceptionBase
      - org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException

All Implemented Interfaces:

Serializable
```
public class InvalidParameterException
extends OMRSCheckedExceptionBase
```
The InvalidParameterException is thrown by an OMRS Connector when the parameters passed to a repository connector, or its accompanying metadata collection, are not valid.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`InvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction)`	Deprecated.
`InvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, String parameterName, Map<String,Object> relatedProperties)`	This is the constructor used when receiving an exception from a remote server.
`InvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String parameterName)`	Deprecated.
`InvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String parameterName, Throwable caughtError)`	Deprecated.
`InvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError)`	Deprecated.
`InvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String parameterName)`	This is the typical constructor used for creating an InvalidParameterException.
`InvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String parameterName, Map<String,Object> relatedProperties)`	This is the typical constructor used for creating an InvalidParameterException.
`InvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String parameterName)`	This is the constructor used for creating an InvalidParameterException when an unexpected error has been caught.
`InvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String parameterName, Map<String,Object> relatedProperties)`	This is the constructor used for creating an InvalidParameterException when an unexpected error has been caught.
`InvalidParameterException(OCFCheckedExceptionBase caughtError, String parameterName)`	This is a copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getParameterName()`	Return the invalid parameter's name, if known.
`String`	`toString()`	JSON-style toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
equals, getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName, hashCode

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidParameterException

public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 String parameterName)

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; parameterName - name of the invalid parameter if known

InvalidParameterException
```
public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 String parameterName,
                                 Map<String,Object> relatedProperties)
```
This is the typical constructor used for creating an InvalidParameterException. 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

parameterName - name of the invalid parameter if known

relatedProperties - arbitrary properties that may help with diagnosing the problem.

InvalidParameterException
```
public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 Throwable caughtError,
                                 String parameterName)
```
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

parameterName - name of the invalid parameter if known

InvalidParameterException
```
public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 Throwable caughtError,
                                 String parameterName,
                                 Map<String,Object> relatedProperties)
```
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

parameterName - name of the invalid parameter if known

relatedProperties - arbitrary properties that may help with diagnosing the problem.

InvalidParameterException
```
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String errorMessageId,
                                 String[] errorMessageParameters,
                                 String systemAction,
                                 String userAction,
                                 String caughtErrorClassName,
                                 String parameterName,
                                 Map<String,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(OCFCheckedExceptionBase caughtError,
                                 String parameterName)

This is a copy constructor.

Parameters:: caughtError - the error that resulted in this exception.; parameterName - new parameter name

InvalidParameterException

@Deprecated
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction)

Deprecated.

This is the typical constructor used for creating a InvalidParameterException.

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

InvalidParameterException

@Deprecated
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 String parameterName)

Deprecated.

This is the typical constructor used for creating a InvalidParameterException.

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,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 Throwable caughtError)

Deprecated.

This is the constructor used for creating a InvalidParameterException 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.

InvalidParameterException

@Deprecated
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 String parameterName,
                                 Throwable caughtError)

Deprecated.

This is the constructor used for creating a InvalidParameterException 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; parameterName - name of the invalid parameter if known; caughtError - the error that resulted in this exception.

Method Detail
- getParameterName
```
public String getParameterName()
```
  Return the invalid parameter's name, if known.
  
  Returns:
  
  string name
- toString
```
public String toString()
```
  JSON-style toString
  
  Overrides:
  
  toString in class OCFCheckedExceptionBase
  
  Returns:
  
  string of property names and values for this enum

Class InvalidParameterException

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

InvalidParameterException

InvalidParameterException

InvalidParameterException

InvalidParameterException

InvalidParameterException

InvalidParameterException

InvalidParameterException

InvalidParameterException

InvalidParameterException

InvalidParameterException

Method Detail

getParameterName

toString