Package org.odpi.openmetadata.adminservices.ffdc.exception

Class OMAGInvalidParameterException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
All Implemented Interfaces:
Serializable
public class OMAGInvalidParameterException extends OCFCheckedExceptionBase
OMAGInvalidParameterException is used when invalid parameters are passed on an OMAG call.
See Also:

  • Constructor Details

    • OMAGInvalidParameterException

      public OMAGInvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription)
      This is the typical constructor used for creating an OCFCheckedException.
      Parameters:
      messageDefinition - content of the message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected

    • OMAGInvalidParameterException

      public OMAGInvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties)
      This is the typical constructor used for creating an OCFCheckedException. 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
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • OMAGInvalidParameterException

      public OMAGInvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError)
      This is the constructor used for creating an OCFCheckedException 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

    • OMAGInvalidParameterException

      public OMAGInvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties)
      This is the constructor used for creating an OCFCheckedException 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
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • OMAGInvalidParameterException

      public OMAGInvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, 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
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • OMAGInvalidParameterException

      public OMAGInvalidParameterException(String errorMessage, OCFCheckedExceptionBase template)
      This is the copy/clone constructor used for creating an exception.
      Parameters:
      errorMessage - associated message
      template - object to copy

    • OMAGInvalidParameterException

      @Deprecated public OMAGInvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction)
      Deprecated.
      This is the typical constructor used for creating a OMAGInvalidParameterException.
      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

    • OMAGInvalidParameterException

      @Deprecated public OMAGInvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError)
      Deprecated.
      This is the constructor used for creating a OMAGInvalidParameterException 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.