Package de.xima.fc.workflow.processor.logic.execution

Class StandardErrorAttachmentListProcessor<R>

java.lang.Object

de.xima.fc.workflow.processor.logic.execution.StandardErrorAttachmentListProcessor<R>

Type Parameters:

R - Type of the combined result of all attachment items.

All Implemented Interfaces:

IResolvedAttachmentListProcessor<R,NodeThrewException>

public class StandardErrorAttachmentListProcessor<R>
extends Object
implements IResolvedAttachmentListProcessor<R,NodeThrewException>

Standard implementation for IResolvedAttachmentListProcessor with the standard error behavior used by most built-in actions.

This class is designed to be extended, you can override all on* methods to customize the behavior for a specific error case. These methods may use the errorCreator to create the error data. The collector() method returns the collector that was passed to the constructor.

The default error behavior is as follows:

• Form record attachment query: Soft error NoSourceAttachmentFound when not a single attachment was found.
• Attachments from previously executed node: Hard error NoSourceAttachmentFound when the referenced node does not exist in the workflow, soft error NoSourceAttachmentFound when the node was not executed or does not provide any attachments.
• Uploads: Hard error NoSourceAttachmentFound when the referenced upload element does not exist in the workflow, soft error NoSourceAttachmentFound when no attachment exists for the referenced upload element.

Furthermore, the following errors can occur, irrespective of the attachment item type:

• A soft NoSourceAttachmentFound is produced when at least one resolved attachment was found for a attachment item, but the additional filter excluded all those attachments.
• A hard FileSystem is thrown when attachments could not be read from the attachment system or written to the attachment system.
• A hard DatabaseError is thrown when an error occurred during the communication with the database.
• A hard General error is thrown when an unexpected error occurred that could not be handled otherwise.

Since:

8.1.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
protected Collector<? super IResolvedAttachmentItem,?,R>	collector
protected IStandardAttachmentListResolutionErrorCreator	errorCreator
protected INodeExecutionParams<?>	params
protected boolean	required

Constructor Summary

Constructors

Constructor	Description
StandardErrorAttachmentListProcessor(INodeExecutionParams<?> params, Collector<? super IResolvedAttachmentItem,?,R> collector, IStandardAttachmentListResolutionErrorCreator errorCreator, boolean required)

Method Summary

Modifier and Type	Method	Description
Collector<? super IResolvedAttachmentItem,?,R>	collector()
void	onAttachmentCountReducedToZeroByFilter(AAttachmentListResolutionError.AttachmentCountReducedToZeroByFilter error)	Callback for handling an error of type EAttachmentItemResolutionError.ATTACHMENT_COUNT_REDUCED_TO_ZERO_BY_FILTER_OPTIONS.
void	onAttachmentQueryDoesNotMatch(AAttachmentListResolutionError.AttachmentQueryDoesNotMatch error)	Callback for handling an error of type EAttachmentItemResolutionError.ATTACHMENT_QUERY_DOES_NOT_MATCH.
void	onCannotProcessAttachmentItem(AAttachmentListResolutionError.CannotProcessAttachmentItem error)	Callback for handling an error of type EAttachmentItemResolutionError.CANNOT_PROCESS_ATTACHMENT_ITEM.
void	onCannotProcessAttachmentList(AAttachmentListResolutionError.CannotProcessAttachmentList error)	Callback for handling an error of type EAttachmentItemResolutionError.CANNOT_PROCESS_ATTACHMENT_LIST.
void	onDatabaseError(AAttachmentListResolutionError.DatabaseError error)	Callback for handling an error of type EAttachmentItemResolutionError.DATABASE_ERROR.
void	onFileSystemError(AAttachmentListResolutionError.FileSystemError error)	Callback for handling an error of type EAttachmentItemResolutionError.FILE_SYSTEM_ERROR.
void	onNodeDoesNotExist(AAttachmentListResolutionError.NodeDoesNotExist error)	Callback for handling an error of type EAttachmentItemResolutionError.NODE_DOES_NOT_EXIST.
void	onNodeDoesNotProvideAttachments(AAttachmentListResolutionError.NodeDoesNotProvideAttachments error)	Callback for handling an error of type EAttachmentItemResolutionError.NODE_DOES_NOT_PROVIDE_ATTACHMENTS.
void	onNodeNotExecuted(AAttachmentListResolutionError.NodeNotExecuted error)	Callback for handling an error of type EAttachmentItemResolutionError.NODE_NOT_EXECUTED.
void	onResolvedAttachmentListEmpty()	Callback when all attachment items were resolved and not a single attachment was found.
void	onUploadFieldDoesNotExist(AAttachmentListResolutionError.UploadFieldDoesNotExist error)	Callback for handling an error of type EAttachmentItemResolutionError.UPLOAD_FIELD_DOES_NOT_EXIST.
void	onUploadFieldDoesNotProvideAttachments(AAttachmentListResolutionError.UploadFieldDoesNotProvideAttachments error)	Callback for handling an error of type EAttachmentItemResolutionError.UPLOAD_FIELD_DOES_NOT_PROVIDE_ATTACHMENTS.

Methods inherited from class java.lang.Object

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

Field Detail

collector

protected final Collector<? super IResolvedAttachmentItem,?,R> collector

errorCreator

protected final IStandardAttachmentListResolutionErrorCreator errorCreator

params

protected final INodeExecutionParams<?> params

required

protected final boolean required

Constructor Detail

StandardErrorAttachmentListProcessor

public StandardErrorAttachmentListProcessor(INodeExecutionParams<?> params,
                                            Collector<? super IResolvedAttachmentItem,?,R> collector,
                                            IStandardAttachmentListResolutionErrorCreator errorCreator,
                                            boolean required)

Parameters:

params - Node execution parameters for the currently executed node.

collector - Collector as returned by collector().

errorCreator - Error creator that is used to produce the error code and error data for the soft and hard workflow node errors.

required - Whether at least one attachment is required. When true and no attachments are present, an error is thrown.

Method Detail

collector

public final Collector<? super IResolvedAttachmentItem,?,R> collector()

Specified by:

collector in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Returns:

Collector that combines all attachment items into the final result.

onAttachmentCountReducedToZeroByFilter

public void onAttachmentCountReducedToZeroByFilter(AAttachmentListResolutionError.AttachmentCountReducedToZeroByFilter error)
                                            throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.ATTACHMENT_COUNT_REDUCED_TO_ZERO_BY_FILTER_OPTIONS.

Specified by:

onAttachmentCountReducedToZeroByFilter in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onAttachmentQueryDoesNotMatch

public void onAttachmentQueryDoesNotMatch(AAttachmentListResolutionError.AttachmentQueryDoesNotMatch error)
                                   throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.ATTACHMENT_QUERY_DOES_NOT_MATCH.

Specified by:

onAttachmentQueryDoesNotMatch in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onCannotProcessAttachmentItem

public void onCannotProcessAttachmentItem(AAttachmentListResolutionError.CannotProcessAttachmentItem error)
                                   throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.CANNOT_PROCESS_ATTACHMENT_ITEM.

Specified by:

onCannotProcessAttachmentItem in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onCannotProcessAttachmentList

public void onCannotProcessAttachmentList(AAttachmentListResolutionError.CannotProcessAttachmentList error)
                                   throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.CANNOT_PROCESS_ATTACHMENT_LIST.

Specified by:

onCannotProcessAttachmentList in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onDatabaseError

public void onDatabaseError(AAttachmentListResolutionError.DatabaseError error)
                     throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.DATABASE_ERROR.

Specified by:

onDatabaseError in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onFileSystemError

public void onFileSystemError(AAttachmentListResolutionError.FileSystemError error)
                       throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.FILE_SYSTEM_ERROR.

Specified by:

onFileSystemError in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onNodeDoesNotExist

public void onNodeDoesNotExist(AAttachmentListResolutionError.NodeDoesNotExist error)
                        throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.NODE_DOES_NOT_EXIST.

Specified by:

onNodeDoesNotExist in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onNodeDoesNotProvideAttachments

public void onNodeDoesNotProvideAttachments(AAttachmentListResolutionError.NodeDoesNotProvideAttachments error)
                                     throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.NODE_DOES_NOT_PROVIDE_ATTACHMENTS.

Specified by:

onNodeDoesNotProvideAttachments in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onNodeNotExecuted

public void onNodeNotExecuted(AAttachmentListResolutionError.NodeNotExecuted error)
                       throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.NODE_NOT_EXECUTED.

Specified by:

onNodeNotExecuted in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onResolvedAttachmentListEmpty

public void onResolvedAttachmentListEmpty()
                                   throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback when all attachment items were resolved and not a single attachment was found.

Specified by:

onResolvedAttachmentListEmpty in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Throws:

NodeThrewException

onUploadFieldDoesNotExist

public void onUploadFieldDoesNotExist(AAttachmentListResolutionError.UploadFieldDoesNotExist error)
                               throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.UPLOAD_FIELD_DOES_NOT_EXIST.

Specified by:

onUploadFieldDoesNotExist in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException

onUploadFieldDoesNotProvideAttachments

public void onUploadFieldDoesNotProvideAttachments(AAttachmentListResolutionError.UploadFieldDoesNotProvideAttachments error)
                                            throws NodeThrewException

Description copied from interface: IResolvedAttachmentListProcessor

Callback for handling an error of type EAttachmentItemResolutionError.UPLOAD_FIELD_DOES_NOT_PROVIDE_ATTACHMENTS.

Specified by:

onUploadFieldDoesNotProvideAttachments in interface IResolvedAttachmentListProcessor<R,NodeThrewException>

Parameters:

error - The error that occurred.

Throws:

NodeThrewException