org.odpi.openmetadata.repositoryservices.ffdc.exception

Class InvalidEntityException

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

All Implemented Interfaces:

Serializable

public class InvalidEntityException
extends OMRSCheckedExceptionBase

InvalidEntityException provides a checked exception for reporting that an entity can not be added because its content is invalid. The OMRSErrorCode adds specific details for the cause/effect of the error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidEntityException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction) This is the typical constructor for creating an InvalidEntityException.
InvalidEntityException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtException) This constructor is used when an unexpected exception has been caught that needs to be wrapped in a InvalidEntityException in order to add the essential details about the error, where it occurred and how to fix it.

Method Summary

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

equals, getErrorMessage, getRelatedProperties, getReportedCaughtException, 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

InvalidEntityException

public InvalidEntityException(int httpCode,
                              String className,
                              String actionDescription,
                              String errorMessage,
                              String systemAction,
                              String userAction)

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

InvalidEntityException

public InvalidEntityException(int httpCode,
                              String className,
                              String actionDescription,
                              String errorMessage,
                              String systemAction,
                              String userAction,
                              Throwable caughtException)

This constructor is used when an unexpected exception has been caught that needs to be wrapped in a InvalidEntityException 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