Package de.xima.fc.workflow.mixin
Interface IBuiltinNodeType<TData>
-
- Type Parameters:
TData
- Type of the node's properties model.
- All Superinterfaces:
Comparable<IOrderable>
,ICustomParametersUpdateable
,IElementHandler<TData,WorkflowNode>
,IExecutionResultDescriptor
,IListenerRegistrator
,INodeHandler<TData>
,IOfficialHelpPageElement<TData,WorkflowNode>
,IOfficialHelpPageNode<TData>
,IOrderable
,IResourceBundleLocator
,IWorkflowElementTypeProviding
,IWorkflowNodeFlowAnalyzer<TData>
,IWorkflowNodeTypeProviding
- All Known Subinterfaces:
ISingleBaseActionBuiltinNodePrototype<TData>
,ISingleBuiltinNodePrototype<TData>
- All Known Implementing Classes:
FcChangeFormAvailabilityHandler
,FcChangeFormValueHandler
,FcChangeStateHandler
,FcCompressAsZipHandler
,FcCopyFormRecordHandler
,FcCounterHandler
,FcCreateTextFileHandler
,FcDeleteFormRecordHandler
,FcDoiInitHandler
,FcEmailHandler
,FcEmptyHandler
,FcExperimentHandler
,FcExportToPersistenceHandler
,FcExportToXmlHandler
,FcFillPdfHandler
,FcFillWordHandler
,FcHttpRequestHandler
,FcImportFormValueFromXmlHandler
,FcLdapQueryHandler
,FcMoveFormRecordToInboxHandler
,FcMultipleConditionHandler
,FcProvideResourceHandler
,FcQueueTaskHandler
,FcRedirectHandler
,FcRenewProcessIdHandler
,FcReturnFileHandler
,FcReturnHandler
,FcSaveToFileSystemHandler
,FcSequenceHandler
,FcSetSavedFlagHandler
,FcShowTemplateHandler
,FcSqlStatementHandler
,FcThrowExceptionHandler
,FcWriteFormRecordAttrHandler
public interface IBuiltinNodeType<TData> extends INodeHandler<TData>, IOfficialHelpPageNode<TData>, IListenerRegistrator
Mixin for all built-in workflow node handlers.Takes the
AWorkflowElement.getType()
from theEWorkflowNodeType
.Registers the handler when the system is started.
- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
CURRENT_HANDLER_VERSION
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description EWorkflowNodeType
getBuiltinType()
default String
getOfficialHelpPagePath()
default String
getType()
default boolean
isAvailable(IIsAvailableParams<TData> params)
Checks whether this workflow element is available to the given client.default void
register()
Invoked by the system and may perform whatever setup logic is required.-
Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersUpdateable
updateCustomParams
-
Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getJavaScript, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
execute, getLocalizedTypeName, getNodePrototypes, getPropertiesBeanClass, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IOfficialHelpPageElement
getHelpPageLocation
-
Methods inherited from interface de.xima.fc.listener.IOrderable
compareTo, shouldBeAfter
-
Methods inherited from interface de.xima.fc.interfaces.workflow.analysis.IWorkflowNodeFlowAnalyzer
createFlowGraph
-
-
-
-
Method Detail
-
getBuiltinType
EWorkflowNodeType getBuiltinType()
- Returns:
- The built-in node type.
-
getOfficialHelpPagePath
default String getOfficialHelpPagePath()
- Specified by:
getOfficialHelpPagePath
in interfaceIOfficialHelpPageElement<TData,WorkflowNode>
- Returns:
- The relative path to the help page, e.g.
/xwiki/bin/view/Formcycle/Designer/Workflow/Actions/CreateTextFile
-
getType
default String getType()
- Specified by:
getType
in interfaceIWorkflowElementTypeProviding
- Returns:
- The type of the workflow element that determines how the workflow element behaves. Usually there is a registered handler for each type.
-
isAvailable
default boolean isAvailable(IIsAvailableParams<TData> params)
Description copied from interface:IElementHandler
Checks whether this workflow element is available to the given client. If this returnfalse
, this action cannot be used in the workflow designer, and is skipped during workflow execution.The default implementation always returnstrue
.- Specified by:
isAvailable
in interfaceIElementHandler<TData,WorkflowNode>
- Parameters:
params
- The node's data, the entity context, and the current client.- Returns:
- Whether the workflow element is available to the given client.
-
register
default void register()
Description copied from interface:IListenerRegistrator
Invoked by the system and may perform whatever setup logic is required.- Specified by:
register
in interfaceIListenerRegistrator
-
-