Package com.redwood.scheduler.api.constraint

Class ConstraintViolatedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.redwood.scheduler.infrastructure.exception.BaseSchedulerException

com.redwood.scheduler.infrastructure.exception.SchedulerException

com.redwood.scheduler.api.constraint.ConstraintViolatedException

All Implemented Interfaces:

ExceptionRelatesToAPIObject, ExceptionData, Serializable

public class ConstraintViolatedException
extends SchedulerException
implements ExceptionRelatesToAPIObject

Exception when a constraint is violated. Is used in the context of a job and in the context of a table. This should result in different error messages (when used in the context of a table the message should also include which row in the table violates the constraint).

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConstraintViolatedException(String newErrorCode, String messageFormat, Throwable cause, com.redwood.scheduler.api.model.SchedulerEntity causeObject, String fieldName, Object[] exceptionDataEN, Object[] exceptionData)
	ConstraintViolatedException(Throwable cause, String parameterName, String message, com.redwood.scheduler.api.model.SchedulerEntity entity)	Constraint violated in the context of the given constraint entity.

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
String	getTranslation()	Get a translation for the exception.

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

bestException, getDefaultMessageFormat, getErrorCode, getExceptionData, getLocalizedMessage, getLocalizedMessage, getMessage, 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

ConstraintViolatedException

protected ConstraintViolatedException(String newErrorCode,
                                      String messageFormat,
                                      Throwable cause,
                                      com.redwood.scheduler.api.model.SchedulerEntity causeObject,
                                      String fieldName,
                                      Object[] exceptionDataEN,
                                      Object[] exceptionData)

ConstraintViolatedException

public ConstraintViolatedException(Throwable cause,
                                   String parameterName,
                                   String message,
                                   com.redwood.scheduler.api.model.SchedulerEntity entity)

Constraint violated in the context of the given constraint entity.

Parameters:

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

parameterName - The name of the parameter that failed to validate.

message - The message to pass to the user.

entity - The entity for which the constraint failed.

Method Detail

getTranslation

public String getTranslation()

Description copied from interface: ExceptionData

Get a translation for the exception.

Specified by:

getTranslation in interface ExceptionData

Overrides:

getTranslation in class BaseSchedulerException

Returns:

a translatable description of this 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.

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