org.odpi.openmetadata.accessservices.governanceprogram.ffdc.exceptions

Class EmployeeNumberNotUniqueException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

org.odpi.openmetadata.accessservices.governanceprogram.ffdc.exceptions.GovernanceProgramCheckedExceptionBase

org.odpi.openmetadata.accessservices.governanceprogram.ffdc.exceptions.EmployeeNumberNotUniqueException

All Implemented Interfaces:

Serializable

public class EmployeeNumberNotUniqueException
extends GovernanceProgramCheckedExceptionBase

The EmployeeNumberNotUniqueException is thrown by the OMAS when more than one personal details record is returned for an employee number.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Return comparison result based on the content of the properties.
List<EntityDetail>	getDuplicateProfiles() Return the list of personal profiles that have a duplicate name.
int	hashCode() Return hash code for this object
String	toString() JSON-style toString

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

getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName

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

EmployeeNumberNotUniqueException

public EmployeeNumberNotUniqueException(ExceptionMessageDefinition messageDefinition,
                                        String className,
                                        String actionDescription,
                                        List<EntityDetail> duplicateProfiles)

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

duplicateProfiles - list of profiles for the same employee number

EmployeeNumberNotUniqueException

public EmployeeNumberNotUniqueException(ExceptionMessageDefinition messageDefinition,
                                        String className,
                                        String actionDescription,
                                        List<EntityDetail> duplicateProfiles,
                                        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

duplicateProfiles - list of profiles for the same employee number

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

EmployeeNumberNotUniqueException

public EmployeeNumberNotUniqueException(ExceptionMessageDefinition messageDefinition,
                                        String className,
                                        String actionDescription,
                                        Throwable caughtError,
                                        List<EntityDetail> duplicateProfiles)

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

duplicateProfiles - list of profiles for the same employee number

EmployeeNumberNotUniqueException

public EmployeeNumberNotUniqueException(ExceptionMessageDefinition messageDefinition,
                                        String className,
                                        String actionDescription,
                                        Throwable caughtError,
                                        List<EntityDetail> duplicateProfiles,
                                        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

duplicateProfiles - list of profiles for the same employee number

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

EmployeeNumberNotUniqueException

public EmployeeNumberNotUniqueException(int httpCode,
                                        String className,
                                        String actionDescription,
                                        String errorMessage,
                                        String errorMessageId,
                                        String[] errorMessageParameters,
                                        String systemAction,
                                        String userAction,
                                        String caughtErrorClassName,
                                        List<EntityDetail> duplicateProfiles,
                                        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

duplicateProfiles - list of profiles for the same employee number

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

EmployeeNumberNotUniqueException

@Deprecated
public EmployeeNumberNotUniqueException(int httpCode,
                                                    String className,
                                                    String actionDescription,
                                                    String errorMessage,
                                                    String systemAction,
                                                    String userAction,
                                                    List<EntityDetail> duplicateProfiles)

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

duplicateProfiles - list of profiles for the same employee number

EmployeeNumberNotUniqueException

@Deprecated
public EmployeeNumberNotUniqueException(int httpCode,
                                                    String className,
                                                    String actionDescription,
                                                    String errorMessage,
                                                    String systemAction,
                                                    String userAction,
                                                    Throwable caughtError,
                                                    List<EntityDetail> duplicateProfiles)

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.

duplicateProfiles - list of profiles for the same employee number

Method Detail

getDuplicateProfiles

public List<EntityDetail> getDuplicateProfiles()

Return the list of personal profiles that have a duplicate name.

Returns:

list of profiles

toString

public String toString()

JSON-style toString

Overrides:

toString in class OCFCheckedExceptionBase

Returns:

string of property names and values for this enum

equals

public boolean equals(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

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class OCFCheckedExceptionBase

Returns:

int hash code