Package de.xima.fc.e2e.containerplugin.plugin

Class RedirectToClientInboxNodePlugin

java.lang.Object

de.xima.fc.workflow.mixin.APluginActionNodeHandler<RedirectToClientInboxProps>

de.xima.fc.e2e.containerplugin.plugin.RedirectToClientInboxNodePlugin

All Implemented Interfaces:

INameProviding, ITransferable, INamedUiElement, IResourceBundleLocator, IWorkflowNodeFlowAnalyzer<RedirectToClientInboxProps>, IElementHandler<RedirectToClientInboxProps,WorkflowNode>, IExecutionResultDescriptor, IRefinedExecutionResultDescriptor<RedirectToClientInboxProps>, ICustomParametersUpdateable, IWorkflowElementTypeProviding, IBeanValidatingElement<RedirectToClientInboxProps,WorkflowNode>, IBeanValidatingNode<RedirectToClientInboxProps>, IExecutingLikeActionNode<RedirectToClientInboxProps>, IHierarchyValidatingNode<RedirectToClientInboxProps>, ISingleElementPrototype<RedirectToClientInboxProps,WorkflowNode>, ISingleNodePrototype<RedirectToClientInboxProps>, INodeHandler<RedirectToClientInboxProps>, IWorkflowNodeTypeProviding, IPluginGenericCustomGUI<IPluginWorkflowNodeBean>, IFCPlugin, IPluginWorkflowNode, IBaseActionClientHandlerNode<RedirectToClientInboxProps>, IBaseActionNode<RedirectToClientInboxProps>, IPluginActionNodeHandler<RedirectToClientInboxProps>, ISingleBaseActionNodePrototype<RedirectToClientInboxProps>, Serializable

public class RedirectToClientInboxNodePlugin
extends APluginActionNodeHandler<RedirectToClientInboxProps>

Plugin for E2E tests that redirects to the inbox page containing the mails for the current client.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler

CURRENT_HANDLER_VERSION

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
RedirectToClientInboxNodePlugin()

Method Summary

Modifier and Type	Method	Description
INormalCompletionResult	execute(INodeExecutionParams<RedirectToClientInboxProps> params)	Executes the business logic of this action plugin, and returns the values made available by this action.
Class<ERedirectToClientInboxError>	getErrorCodeClass()	Returns the type of the enumeration that defines the error types that may occur during the execution of a node.
IElementCategory	getMainCategory(IGetElementPrototypesParams params)
String	getName()	Getter for the name of this plugin.
String	getPropertiesViewXhtmlName()
IGuiIcon	getPrototypeIcon(IGetElementPrototypesParams params)	This default implementation returns an icon resembling a jigsaw puzzle piece, which is the default icon for an action plugin.
IElementCategory	getSubCategory(IGetElementPrototypesParams params)	Optional sub category.

Methods inherited from class de.xima.fc.workflow.mixin.APluginActionNodeHandler

getPluginInitializeData, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.workflow.mixin.IBaseActionClientHandlerNode

getActionViewType, getCascadingStyleSheet, getJavaScript, isAlwaysCompletesAbruptly, isCanCompleteAbruptlyByReturning, isCanCompleteAbruptlyByThrowing, isCanCompleteNormally, isSelectable

Methods inherited from interface de.xima.fc.workflow.mixin.IBaseActionNode

isValidChildCount, isValidChildType, isValidParentType, validateLocal

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IBeanValidatingElement

getValidationGroups

Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersUpdateable

updateCustomParams

Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler

extractSearchTerms, getCascadingStyleSheet, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getFilterCriteriaForObjects, getHelpPageLocation, getJavaScript, isAvailable, isHasUserVisibleName, readEntityReferences, readObjectReferences, readPlaceholders, validateGlobal, writeEntityReferences, writeObjectReferences, writePlaceholders

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IExecutingLikeActionNode

createFlowGraph

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor

getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptors, getFileValueDescriptor, getSoftErrorValueDescriptors

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler

getLocalizedTypeName, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

Methods inherited from interface de.xima.fc.workflow.mixin.IPluginActionNodeHandler

extractDescription, extractName, getAlwaysValueDescriptor, getBpmnModeler, getDataModelClass, getDescription, getDisplayName, getErrorValueDescriptor, getI18nKeyActionLabel, getI18nKeyActionSearchText, getI18nKeyActionSubLabel, getI18nKeyActionTitle, getI18nKeyDescription, getI18nKeyDisplayName, getMainPluginBeanClass, getNodeHandler, getPropertiesBeanClass, getPropertiesViewXhtml, getPropertiesViewXhtmlPath, getPrototypeLabel, getPrototypeSearchText, getPrototypeSubLabel, getPrototypeTitle, getResourceBundle, getResourceBundlePath, getSoftErrorCodeClass, getSoftErrorValueDescriptor, getSuccessValueDescriptor, getType, getUnmanagedBeans, getVersion

Methods inherited from interface de.xima.fc.plugin.interfaces.workflow.IPluginWorkflowNode

getXhtmlView

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedExecutionResultDescriptor

getAlwaysValueDescriptor, getAlwaysValueDescriptor, getAttachmentValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getErrorValueDescriptors, getFileValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSoftErrorValueDescriptors, getSuccessValueDescriptor, getSuccessValueDescriptor

Methods inherited from interface de.xima.fc.workflow.mixin.ISingleBaseActionNodePrototype

getPrototypeModelData, getThemeColor

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleElementPrototype

getPrototypeSortKey, getPrototypeTags

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleNodePrototype

getNodePrototypes, getPrototypeElement, getPrototypeElementChildren

Constructor Detail

RedirectToClientInboxNodePlugin

public RedirectToClientInboxNodePlugin()

Method Detail

execute

public INormalCompletionResult execute(INodeExecutionParams<RedirectToClientInboxProps> params)
                                throws AbstractAbruptCompletionException

Description copied from interface: IPluginActionNodeHandler

Executes the business logic of this action plugin, and returns the values made available by this action.

In case the action was executed successfully, you need to return a value that conforms to the data type described by IPluginActionNodeHandler.getSuccessValueDescriptor(IValueDescriptorFactory). See that method for an example on how to use a custom result type. If you did not override that method, no value is returned by this action, and you can simply use:

 return params.normalResult().build();
 

When the action could not be completed normally, you need to throw an appropriate exception indicating the reason for why the action could not be completed. Most commonly this happens when the business logic threw an exception. In this case you should use the provided INodeExecutionParams.throwingException() to build the NodeThrewException, and throw it:

 throw params.throwingResult().cause(exceptionThatWasThrown).build();
 

If you did override IPluginActionNodeHandler.getErrorValueDescriptor(IValueDescriptorFactory), you should also include the error code and error details via INodeThrewExceptionBuilder.error(String, Object) or INodeThrewExceptionBuilder.error(String, Object).

Parameters:

params - Data this action plugin may use. Most importantly, you will need INodeExecutionParams.getData(), which contains the configuration as set by the user in the workflow designer.

Returns:

The values returned by this action, as specified by IPluginActionNodeHandler.getSuccessValueDescriptor(IValueDescriptorFactory)}. Any value not set explicitly will use its default value from the success value descriptor.

Throws:

AbstractAbruptCompletionException - When the node's execution did not finish normally, see below for subclasses.

NodeThrewException - If this exception was thrown by the execute method of the given node. Indicates that a node could not be completed successfully. This exception can be caught by control flow nodes with custom error handling, such as a try-catch node.

NodeReturnedException - If this exception was thrown by the execute method of the given node. Indicates that the node wishes to return, i.e. to stop the execution of the current processing chain (="function"). This exception can be caught by control flow nodes with custom finalization handling, such as a try-finally node (which should rethrow this exception afterward).

NodeTransferredControlException - If this exception was thrown by the execute method of the given node. Indicates that a control transfer should take place. The matching node for the control transfer target should catch this exception and proceed according to the type of the control transfer.

getMainCategory

public IElementCategory getMainCategory(IGetElementPrototypesParams params)

Parameters:

params - Parameters with the current client, locale, entity context etc.

Returns:

IElementCategory element's main category, which is used for grouping the elements.

getName

public String getName()

Description copied from interface: IFCPlugin

Getter for the name of this plugin. This is a technical name that should not appear on the user interface. Implement IFCPlugin.getDisplayName(Locale) for the name that should be shown to the user.

Returns:

String The name of this plugin.

getPropertiesViewXhtmlName

public String getPropertiesViewXhtmlName()

Returns:

The file name (without the path) to the XHTML page with the custom UI. The file extension .xhtml is added automatically if the returned name does not contain it already.

See Also:

IPluginActionNodeHandler.getPropertiesViewXhtmlPath()

getPrototypeIcon

public IGuiIcon getPrototypeIcon(IGetElementPrototypesParams params)

Description copied from interface: IPluginActionNodeHandler

This default implementation returns an icon resembling a jigsaw puzzle piece, which is the default icon for an action plugin.

Parameters:

params - Parameters with the current client, locale, entity context etc.

Returns:

The icon for the element prototype, shown in the element drawer panel to the left of the workflow designer. See IElementPrototypeDescriptor.getIcon().

See Also:

ISingleElementPrototype.getPrototypeIcon(IGetElementPrototypesParams)

getErrorCodeClass

public Class<ERedirectToClientInboxError> getErrorCodeClass()

Description copied from interface: IPluginActionNodeHandler

Returns the type of the enumeration that defines the error types that may occur during the execution of a node. The default returns null, which corresponds to no custom errors. In that case, if the plugin throws an exception, it is treated as a general exception.

Returns:

The enumeration class that defines the possible error codes.

getSubCategory

public IElementCategory getSubCategory(IGetElementPrototypesParams params)

Description copied from interface: ISingleElementPrototype

Optional sub category. When not set or this returns null, the element is shown under the category miscellaneous.

Parameters:

params - Parameters with the current client, locale, entity context etc.

Returns:

IElementCategory element's sub category, which is used for grouping the element within the given main group.