Package com.redwood.scheduler.api.exception

Class ExportException

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.exception.ExportException

All Implemented Interfaces:

ExceptionRelatesToAPIObject, ExceptionData, Serializable

public abstract class ExportException
extends SchedulerException
implements ExceptionRelatesToAPIObject

Base class for exceptions relating to exporting objects.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExportException(String newErrorCode, String messageFormat, Throwable cause, SchedulerEntity causeObject, String fieldName, Object[] exceptionDataEN, Object[] exceptionData)

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

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

ExportException

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

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.