org.odpi.openmetadata.repositoryservices.ffdc.exception

Class TypeDefNotKnownException

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.TypeDefNotKnownException

All Implemented Interfaces:

Serializable

public class TypeDefNotKnownException
extends OMRSCheckedExceptionBase

TypeDefNotKnownException provides a checked exception for reporting that a requested typedef can not be found. The OMRSErrorCode adds specific details for the cause/effect of the error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription) This is the typical constructor used for creating an exception.
TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties) This is the typical constructor used for creating an exception.
TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError) This is the constructor used for creating an exception when an unexpected error has been caught.
TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties) This is the constructor used for creating an exception when an unexpected error has been caught.
TypeDefNotKnownException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) Deprecated.
TypeDefNotKnownException(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.
TypeDefNotKnownException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtException) Deprecated.
TypeDefNotKnownException(TypeErrorException caughtException) Deprecated.

Method Summary

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, toString

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

TypeDefNotKnownException

public TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition,
                                String className,
                                String actionDescription)

This is the typical constructor used for creating an exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

TypeDefNotKnownException

public TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition,
                                String className,
                                String actionDescription,
                                Map<String,Object> relatedProperties)

This is the typical constructor used for creating an exception. 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.

TypeDefNotKnownException

public TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition,
                                String className,
                                String actionDescription,
                                Throwable caughtError)

This is the constructor used for creating an exception 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

TypeDefNotKnownException

public TypeDefNotKnownException(ExceptionMessageDefinition messageDefinition,
                                String className,
                                String actionDescription,
                                Throwable caughtError,
                                Map<String,Object> relatedProperties)

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

TypeDefNotKnownException

public TypeDefNotKnownException(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.

TypeDefNotKnownException

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

Deprecated.

This is the typical constructor for creating a TypeDefNotKnownException. It captures the essential details about the error, where it occurred and how to fix it.

Parameters:

httpCode - code to use across a REST interface

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

TypeDefNotKnownException

@Deprecated
public TypeDefNotKnownException(TypeErrorException caughtException)

Deprecated.

This constructor is used when an unexpected type error exception has been caught that needs to be wrapped in a TypeDefNotKnownException in order to add the essential details about the error, where it occurred and how to fix it.

Parameters:

caughtException - the exception/error that caused this exception to be raised

TypeDefNotKnownException

@Deprecated
public TypeDefNotKnownException(int httpCode,
                                            String className,
                                            String actionDescription,
                                            String errorMessage,
                                            String systemAction,
                                            String userAction,
                                            Throwable caughtException)

Deprecated.

This constructor is used when an unexpected exception has been caught that needs to be wrapped in a TypeDefNotKnownException in order to add the essential details about the error, where it occurred and how to fix it.

Parameters:

httpCode - code to use across a REST interface

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

caughtException - the exception/error that caused this exception to be raised