Package com.redwood.scheduler.api.exception

Class ParameterWrongTypeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.redwood.scheduler.infrastructure.exception.SchedulerRuntimeException

com.redwood.scheduler.api.exception.SchedulerAPIRuntimeException

com.redwood.scheduler.api.exception.ParameterWrongTypeException

All Implemented Interfaces:

ExceptionRelatesToAPIObject, ExceptionData, Serializable

@Generated("build/redwood/jbs/generated-exceptions/Exceptions.java.tmpl")
public class ParameterWrongTypeException
extends SchedulerAPIRuntimeException
implements ExceptionRelatesToAPIObject

A Parameter was set, but using the wrong type of data.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParameterWrongTypeException(String newErrorCode, String messageFormat, Throwable cause, SchedulerEntity causeObject, String fieldName, Object[] exceptionDataEN, Object[] exceptionData)
	ParameterWrongTypeException(Throwable cause, String expectedType, String receivedType, SchedulerEntity causeObject, String fieldName)	A Parameter was set, but using the wrong type of data.

Method Summary

Modifier and Type	Method	Description
String	getRelatedField()	If the cause of the exception is caused by a specific field then it returns the name of the field
String	getRelatedObjectType()	What is the object type of the object that caused the exception
Long	getRelatedUid()	What is the UniqueId of the object that caused the exception

Methods inherited from class com.redwood.scheduler.infrastructure.exception.SchedulerRuntimeException

bestException, getDefaultMessageFormat, getErrorCode, getExceptionData, getLocalizedMessage, getLocalizedMessage, getMessage, getMessageUnformatted, getTranslation, isSystemLoggable, skipException, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterWrongTypeException

protected ParameterWrongTypeException(String newErrorCode,
                                      String messageFormat,
                                      Throwable cause,
                                      SchedulerEntity causeObject,
                                      String fieldName,
                                      Object[] exceptionDataEN,
                                      Object[] exceptionData)

ParameterWrongTypeException

public ParameterWrongTypeException(Throwable cause,
                                   String expectedType,
                                   String receivedType,
                                   SchedulerEntity causeObject,
                                   String fieldName)

A Parameter was set, but using the wrong type of data.

Parameters:

cause - The originating exception, null if this is the originating exception

expectedType - The type that the Parameter was expecting.

receivedType - The type that the Parameter was given.

causeObject - the object that caused the exception

fieldName - Name of the field that caused the exception, null if not applicable.

Method Detail

getRelatedObjectType

public final String getRelatedObjectType()

Description copied from interface: ExceptionRelatesToAPIObject

What is the object type of the object that caused the exception

Specified by:

getRelatedObjectType in interface ExceptionRelatesToAPIObject

Returns:

the object type of the object that caused the excpetion

getRelatedUid

public final Long getRelatedUid()

Description copied from interface: ExceptionRelatesToAPIObject

What is the UniqueId of the object that caused the exception

Specified by:

getRelatedUid in interface ExceptionRelatesToAPIObject

Returns:

the UniqueId of the object that caused the exception

getRelatedField

public final String getRelatedField()

Description copied from interface: ExceptionRelatesToAPIObject

If the cause of the exception is caused by a specific field then it returns the name of the field

Specified by:

getRelatedField in interface ExceptionRelatesToAPIObject

Returns:

the name of the field that caused the exception, otherwise it returns null.