de.aristaflow.adept2.model.datamanagement

Class InvalidDataTypeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.aristaflow.adept2.model.datamanagement.InvalidDataTypeException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InvalidUDTException

public class InvalidDataTypeException
extends java.lang.Exception

An InvalidDataTypeException indicates the non-conformance of an expected data type with the actual data type. For instance, an integer is expected but the designated data element is of reference-type.

Author:

Ulrich Kreher

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessConstants.AdeptDataType	actualDataType The ADEPT2-data element type of which the data element actually is.
protected java.lang.Integer	dataElementID The ID of the data element which has been requested but is of the wrong type or null in case this exception has been raised when accessing a parameter.
protected ProcessConstants.AdeptDataType	expectedDataType The ADEPT2-data element type that is expected by the caller of a datamanager-method.
protected java.util.UUID	instanceID The ID of the process instance of which a data element has been requested which is of the wrong type or null in case this exception has been raised when accessing a parameter.
protected java.lang.String	parameterName The name of the parameter which has been requested and which is of the wrong type.

Constructor Summary

Constructors

Constructor and Description
InvalidDataTypeException(java.lang.String parameterName, ProcessConstants.AdeptDataType expectedDataType, ProcessConstants.AdeptDataType actualDataType) Constructs a new InvalidDataTypeException to indicate that the designated expected data type of the designated parameter does not correspond to the actual data type.
InvalidDataTypeException(java.lang.String msg, java.lang.String parameterName, ProcessConstants.AdeptDataType parameterType) Constructs a new InvalidDataTypeException to indicate that the designated data type of the designated parameter does not correspond to the encountered type.
InvalidDataTypeException(java.util.UUID instanceID, int dataElementID, ProcessConstants.AdeptDataType expectedDataType, ProcessConstants.AdeptDataType actualDataType) Constructs a new InvalidDataTypeException to indicate that the designated expected data type of the designated data element does not correspond to the actual data type.

Method Summary

Modifier and Type	Method and Description
ProcessConstants.AdeptDataType	getActualDataType() Gets the ADEPT2-data element type that is expected by the caller of a datamanager-method.
java.lang.Integer	getDataElementID() Gets the ID of the data element which has been requested but is of the wrong type.
ProcessConstants.AdeptDataType	getExpectedDataType() The ADEPT2-data element type of which the data element actually is.
java.util.UUID	getInstanceID() Gets the ID of the process instance of which a data element has been requested which is of the wrong type.
java.lang.String	getParameterName() Gets the name of the parameter which has been requested and which is of the wrong type.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

parameterName

protected final java.lang.String parameterName

The name of the parameter which has been requested and which is of the wrong type.

instanceID

protected final java.util.UUID instanceID

The ID of the process instance of which a data element has been requested which is of the wrong type or null in case this exception has been raised when accessing a parameter.

dataElementID

protected final java.lang.Integer dataElementID

The ID of the data element which has been requested but is of the wrong type or null in case this exception has been raised when accessing a parameter.

expectedDataType

protected final ProcessConstants.AdeptDataType expectedDataType

The ADEPT2-data element type that is expected by the caller of a datamanager-method. This is null in case the expected data type is unknown, for instance when switching over the actual data type.

actualDataType

protected final ProcessConstants.AdeptDataType actualDataType

The ADEPT2-data element type of which the data element actually is. This is null in case the data element is not existent.

Constructor Detail

InvalidDataTypeException

public InvalidDataTypeException(java.lang.String parameterName,
                                ProcessConstants.AdeptDataType expectedDataType,
                                ProcessConstants.AdeptDataType actualDataType)

Constructs a new InvalidDataTypeException to indicate that the designated expected data type of the designated parameter does not correspond to the actual data type.

Parameters:

parameterName - The name of the parameter which has been requested and which is of the wrong type.

expectedDataType - The data type that the caller expected when invoking the method that leads to this exception. This may be null to indicate that the expected data type is unknown, for instance when switching over the actual data type.

actualDataType - The actual data type of the data element that the caller designated. Can be null if the data element is not existent.

InvalidDataTypeException

public InvalidDataTypeException(java.lang.String msg,
                                java.lang.String parameterName,
                                ProcessConstants.AdeptDataType parameterType)

Constructs a new InvalidDataTypeException to indicate that the designated data type of the designated parameter does not correspond to the encountered type. Further information has to be provided via the message!

Parameters:

msg - The message providing additional information on the type conversion that does not work.

parameterName - The name of the parameter which is of the wrong type.

parameterType - The data type of the parameter which is incompatible with the encountered type.

InvalidDataTypeException

public InvalidDataTypeException(java.util.UUID instanceID,
                                int dataElementID,
                                ProcessConstants.AdeptDataType expectedDataType,
                                ProcessConstants.AdeptDataType actualDataType)

Constructs a new InvalidDataTypeException to indicate that the designated expected data type of the designated data element does not correspond to the actual data type.

Parameters:

instanceID - The ID of the process instance of which a data element has been requested which is of the wrong type.

dataElementID - The ID of the data element which has been requested but is of the wrong type.

expectedDataType - The data type that the caller expected when invoking the method that leads to this exception. This may be null to indicate that the expected data type is unknown, for instance when switching over the actual data type.

actualDataType - The actual data type of the data element that the caller designated. Can be null if the data element is not existent.

Method Detail

getParameterName

public java.lang.String getParameterName()

Gets the name of the parameter which has been requested and which is of the wrong type. If this is null, check for the instance ID and the data element ID.

Returns:

The name of the parameter which has been requested and which is of the wrong type or null in case this exception has been raised when accessing a data element.

getInstanceID

public java.util.UUID getInstanceID()

Gets the ID of the process instance of which a data element has been requested which is of the wrong type. If this is null, check for the parameter name.

Returns:

The ID of the process instance of which a data element has been requested which is of the wrong type or null in case this exception has been raised when accessing a parameter.

getDataElementID

public java.lang.Integer getDataElementID()

Gets the ID of the data element which has been requested but is of the wrong type. If this is null, check for the parameter name.

Returns:

The ID of the data element which has been requested but is of the wrong type or null in case this exception has been raised when accessing a parameter.

getActualDataType

public ProcessConstants.AdeptDataType getActualDataType()

Gets the ADEPT2-data element type that is expected by the caller of a datamanager-method.

Returns:

The actual data type or null in case the data element is not existing.

getExpectedDataType

public ProcessConstants.AdeptDataType getExpectedDataType()

The ADEPT2-data element type of which the data element actually is. This may be null to indicate that the expected data type is unknown, for instance when switching over the actual data type.

Returns:

The expected data type or null in case the expected data type is unknown.