Package com.redwood.scheduler.infrastructure.exception

Interface ExceptionData

All Known Implementing Classes:

AmbiguousBrowseableProcessServerServiceException, BaseSchedulerException, ConstraintViolatedException, CredentialEncodingException, CredentialNotExternallyAvailableException, CredentialNotFoundException, DateTimeConstantOutOfBoundsException, DirtyListNotEmptyException, DuplicateKeyException, ExportException, ExtensionPointURLException, FileException, FileTransientException, ImportOverrideException, InactiveUserCannotLoginException, IncorrectFormatRuntimeException, InsufficientLicensesException, InvalidLicensableItemValueException, InvalidObjectNameException, JobFileException, JobFileTransientException, JobHasNoParentException, JobNotFoundRuntimeException, LicenseException, ListDirectoryException, ListDirectoryTransientException, ListOSUserSessionsException, MailInvalidArmorException, ModifiedJobDefinitionCannotBePreparedException, NoTimeZoneForTimeWindowCalculation, NotWithinAChainException, ObjectCreationNotAllowedException, ObjectDeletedException, ObjectMutableInOtherSubSessionException, ObjectNotAttachedToSessionException, ObjectNotFromSameSessionException, ParameterDefaultValueUnavailableException, ParameterWrongTypeException, PendingEventsNotAllowedException, PerformRFCActionException, PerformRFCActionPasswordExpiredException, PerformRFCActionTransientException, PerformSocketOperationException, PerformSocketOperationTransientException, PeriodFunctionErrorException, PeriodFunctionNoInterfaceException, PersistenceFactoryInstantiationException, ProcessServerCheckException, ProcessServerCheckFailException, ProcessServerCheckSystemException, ProcessServerCheckValidateException, RecurrenceException, RecurrencePatternException, ReportGenerationException, ReportValidationException, ReturnCodeMappingUnavailableException, SchedulerAPIException, SchedulerAPIForeignKeyException, SchedulerAPIInvalidObjectTypeException, SchedulerAPIInvalidRestrictedEnumerationException, SchedulerAPIInvalidStringLiteralException, SchedulerAPINoRowsUpdatedException, SchedulerAPIPersistenceException, SchedulerAPIPersistenceRuntimeException, SchedulerAPIRetriablePersistenceException, SchedulerAPIRuntimeException, SchedulerAPIUnavailableException, SchedulerConfigurationException, SchedulerCustomException, SchedulerCustomLowLevelException, SchedulerCustomLowLevelRuntimeException, SchedulerCustomRuntimeException, SchedulerException, SchedulerRuntimeException, SchedulingParameterValueException, StepDoesNotExistException, SubjectNotCreatedException, TimeWindowElementConstraintOutOfBoundsException, TimeWindowException, TimeWindowExpectedOpenWindowException, TimeWindowNullOpeningTimeException, UnlicensedFeatureException, UnsupportedObjectException, UnsupportedPermaLinkException, UserMessageAttachmentException

public interface ExceptionData

Provide access to the data in an exception for internationalization.

Method Summary

Modifier and Type	Method	Description
boolean	bestException()	Is this exception the best exception for the purposes of the UI? Exceptions implementing this _MUST_ make sure that they display all or more information than their causes.
String	getDefaultMessageFormat()	Get the default (US English) message format.
String	getErrorCode()	Get the JCS error code of this exception.
Object[]	getExceptionData()	Get the data from the exception for formatting.
String	getTranslation()	Get a translation for the exception.
boolean	isSystemLoggable()	Should this exception be logged to the system log, or only to the trace file.
boolean	skipException()	Should this exception be skipped for the purposes of showing an exception dump to the user.

Method Detail

getExceptionData

Object[] getExceptionData()

Get the data from the exception for formatting.

Returns:

the exception data.

getDefaultMessageFormat

String getDefaultMessageFormat()

Get the default (US English) message format.

Returns:

the message format

getTranslation

String getTranslation()

Get a translation for the exception.

Returns:

a translatable description of this exception.

isSystemLoggable

boolean isSystemLoggable()

Should this exception be logged to the system log, or only to the trace file.

Returns:

whether this should be logged to the system log, or only to the trace file

skipException

boolean skipException()

Should this exception be skipped for the purposes of showing an exception dump to the user.

Returns:

true if so, false otherwise.

bestException

boolean bestException()

Is this exception the best exception for the purposes of the UI? Exceptions implementing this _MUST_ make sure that they display all or more information than their causes.

Returns:

true if so, false otherwise.

getErrorCode

String getErrorCode()

Get the JCS error code of this exception.

Returns:

the JCS error code, without the leading "JCS-"