Class WorkflowNodePropsFactory
- java.lang.Object
-
- de.xima.fc.workflow.processor.factory.WorkflowNodePropsFactory
-
public final class WorkflowNodePropsFactory extends Object
Factory methods for creating various kinds ofWorkflowNodemodels.- Since:
- 8.0.1
- Author:
- XIMA MEDIA GmbH
-
-
Constructor Summary
Constructors Constructor Description WorkflowNodePropsFactory()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static FcBreakPropsbreakStatement()Creates a new workflow node model for aEWorkflowNodeType.FC_BREAKthat issues a control transfer via a break statement, targeting the closest control flow node.static FcBreakPropsbreakStatement(NodeKey breakTarget)Creates a new workflow node model for aEWorkflowNodeType.FC_BREAKthat issues a control transfer via a break statement.static FcChangeFormAvailabilityPropschangeFormAvailability(EChangeFormAvailabilityType changeType)Creates a new workflow node model for aEWorkflowNodeType.FC_CHANGE_FORM_AVAILABILITYthat changes the availability of a form.static FcChangeFormValuePropschangeFormValue(Map<String,String> formValues)Creates a new workflow node model for aEWorkflowNodeType.FC_CHANGE_FORM_VALUEthat modifies the value of one or more form elements.static FcChangeStatePropschangeState(WorkflowState state)Creates a new workflow node model for aEWorkflowNodeType.FC_CHANGE_STATEthat changes the current form record to the given state.static FcCompressAsZipPropscompressAsZip(MultiFile multiFile, String compressedFileName)Creates a new workflow node model for aEWorkflowNodeType.FC_COMPRESS_AS_ZIPthat creates a ZIP file form the input files.static FcCompressAsZipPropscompressAsZip(MultiFile multiFile, String compressedFileName, boolean attachToFormRecord)Creates a new workflow node model for aEWorkflowNodeType.FC_COMPRESS_AS_ZIPthat creates a ZIP file form the input files.static FcCompressAsZipPropscompressAsZip(MultiFile multiFile, String compressedFileName, boolean attachToFormRecord, ECompressAsZipNamingScheme namingScheme)Creates a new workflow node model for aEWorkflowNodeType.FC_COMPRESS_AS_ZIPthat creates a ZIP file form the input files.static FcContinuePropscontinueStatement()Creates a new workflow node model for aEWorkflowNodeType.FC_CONTINUEthat issues a control transfer via a continue statement, targeting the closest control flow node.static FcContinuePropscontinueStatement(NodeKey continueTarget)Creates a new workflow node model for aEWorkflowNodeType.FC_CONTINUEthat issues a control transfer via a continue statement.static FcCopyFormRecordPropscopyFormRecord(boolean anonymizeUserMetadata)Creates a new workflow node model for aEWorkflowNodeType.FC_COPY_FORM_RECORDthat moves the current form record to the given inbox.static FcCopyFormRecordPropscopyFormRecord(boolean anonymizeUserMetadata, WorkflowTrigger triggerToInvoke, Postfach targetInbox)Creates a new workflow node model for aEWorkflowNodeType.FC_COPY_FORM_RECORDthat moves the current form record to the given inbox.static FcCounterPropscounter(ClientCounter counter, ECounterActionType actionType, String step)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat modifies a certain client counter.static FcCounterPropscounter(String counterName, ECounterActionType actionType, String step)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat modifies a certain client counter.static FcCounterPropscounterDecrement(ClientCounter counter, String step)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat decrements a client counter.static FcCounterPropscounterDecrement(String counterName, String step)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat decrements a client counter.static FcCounterPropscounterIncrement(ClientCounter counter, String step)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat increments a client counter.static FcCounterPropscounterIncrement(String counterName, String step)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat increments a client counter.static FcCounterPropscounterReset(ClientCounter counter)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat resets a client counter.static FcCounterPropscounterReset(String counterName)Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat resets a client counter.protected static Setting<String>createCustomSetting(String name, String value, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)protected static List<Setting<String>>createCustomSettings(Iterable<Map.Entry<String,String>> map, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)protected static List<Setting<String>>createCustomSettings(Map<String,String> map, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)protected static List<Setting<String>>createCustomSettingsMultiValues(Iterable<Map.Entry<String,List<String>>> map, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)protected static List<Setting<String>>createCustomSettingsMultiValues(Map<String,List<String>> map, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)static ICreateTextFileNodeBuildercreateTextFile()Creates a new builder for configuring a workflow node for aEWorkflowNodeType.FC_CREATE_TEXT_FILEthat creates a text file with the given content and the default encoding.static FcCreateTextFilePropscreateTextFile(String fileName, String fileContent)Creates a new workflow node model for aEWorkflowNodeType.FC_CREATE_TEXT_FILEthat creates a text file with the given content and the default encoding.static FcSqlStatementPropsdatabaseQuery(DatenbankZugriff databaseConnection, String sqlStatement)Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTwith a SQL statement.static FcSqlStatementPropsdatabaseQuery(Datenquelle databaseQuery)Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTthat uses a preconfigured database query.static FcSqlStatementPropsdatabaseQuery(Datenquelle databaseQuery, Iterable<Map.Entry<String,String>> queryParameters)Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTthat uses a preconfigured database query.static FcSqlStatementPropsdatabaseQuery(Datenquelle databaseQuery, Map<String,String> queryParameters)Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTthat uses a preconfigured database query.static FcDecodeBase64PropsdecodeBase64(String value)Creates a new workflow node model for aEWorkflowNodeType.FC_ENCODE_BASE64that converts a binary file to base64.static FcDecodeBase64PropsdecodeBase64(String value, String exportName, boolean attachToFormRecord)Creates a new workflow node model for aEWorkflowNodeType.FC_ENCODE_BASE64that converts a binary file to base64.static FcDeleteAttachmentPropsdeleteAttachment(MultiAttachment attachmentsToDelete)Creates a new workflow node model for aEWorkflowNodeType.FC_DELETE_ATTACHMENTthat deletes attachments from the current form record.static FcDeleteFormRecordPropsdeleteFormRecord()Creates a new workflow node model for aEWorkflowNodeType.FC_DELETE_FORM_RECORDthat deletes the current form record when executed.static FcDoiInitPropsdoiInit(String from, Iterable<String> to, String subject, String htmlBody, String plainTextBody, Textbaustein doiFailTemplate)Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.static FcDoiInitPropsdoiInitHtml(String from, Iterable<String> to, String subject, String body)Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.static FcDoiInitPropsdoiInitHtml(String from, Iterable<String> to, String subject, String body, Textbaustein doiFailTemplate)Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.static FcDoiInitPropsdoiInitPlain(String from, Iterable<String> to, String subject, String body)Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.static FcDoiInitPropsdoiInitPlain(String from, Iterable<String> to, String subject, String body, Textbaustein doiFailTemplate)Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.static IEmailNodeBuilderemail(String from)Creates a builder for a new workflow node for aEWorkflowNodeType.FC_EMAILthat sends an email to a given list of recipients.static FcEmailPropsemail(String from, Iterable<String> to, String subject, String htmlBody, String plainTextBody)Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an email to one or more recipients.static FcEmailPropsemail(String from, Iterable<String> to, String subject, String htmlBody, String plainTextBody, MultiFile attachments)Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an email to one or more recipients.static FcEmailPropsemailHtml(String from, Iterable<String> to, String subject, String body)Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an HTML email to one or more recipients.static FcEmailPropsemailHtml(String from, Iterable<String> to, String subject, String body, MultiFile attachments)Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an HTML email to one or more recipients.static FcEmailPropsemailPlainText(String from, Iterable<String> to, String subject, String body)Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends a plain text email to one or more recipients.static FcEmailPropsemailPlainText(String from, Iterable<String> to, String subject, String body, MultiFile attachments)Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends a plain text email to one or more recipients.static FcEncodeBase64PropsencodeBase64(SingleFile file)Creates a new workflow node model for aEWorkflowNodeType.FC_ENCODE_BASE64that converts a binary file to base64.static FcExperimentPropsexperiment()Creates a new workflow node model for aEWorkflowNodeType.FC_EXPERIMENTthat catches exception that occur while the block is executed.static FcExportFormRecordChatsPropsexportFormRecordChats()Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates an export file with the chat history of a form record.static FcExportFormRecordChatsPropsexportFormRecordChats(String fileName)Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATSthat exports the chat history of a form record to a PDF document.static FcExportFormRecordChatsPropsexportFormRecordChats(String exportName, boolean attachToFormRecord)Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATSthat creates a export file with the chat history of a form record.static FcExportToPersistencePropsexportToPersistence()Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.static FcExportToPersistencePropsexportToPersistence(String exportName)Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.static FcExportToPersistencePropsexportToPersistence(String exportName, boolean attachToFormRecord)Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.static FcExportToXmlPropsexportToXml()Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.static FcExportToXmlPropsexportToXml(String exportName)Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.static FcExportToXmlPropsexportToXml(String exportName, boolean attachToFormRecord)Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.static FcExportToXmlPropsexportToXml(String exportName, boolean attachToFormRecord, Iterable<EExportToXmlField> exportFields, Textbaustein xslTemplate)Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.static FcFillPdfPropsfillPdf(SingleFile pdfDocument)Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_PDFthat fills a PDF document with the submitted form data.static FcFillPdfPropsfillPdf(SingleFile pdfDocument, String exportName, boolean attachToFormRecord, String font)Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_PDFthat fills a PDF document with the submitted form data.static FcFillWordPropsfillWord(SingleFile wordDocument)Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_WORDthat fills a Word document with the submitted form data.static FcFillWordPropsfillWord(SingleFile wordDocument, String exportName, boolean attachToFormRecord)Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_WORDthat fills a Word document with the submitted form data.static IHttpRequestNodeBuilderhttpRequest(EHttpVerb httpVerb, String endpointUrl)Creates a builder for a new workflow node for aEWorkflowNodeType.FC_POST_REQUESTthat sends an HTTP request to the given URL.static IHttpRequestNodeBuilderhttpRequest(String httpVerb, String endpointUrl)Creates a builder for a new workflow node for aEWorkflowNodeType.FC_POST_REQUESTthat sends an HTTP request to the given URL.static FcImportFormValueFromXmlPropsimportFormValueFromXml(SingleFile xmlDocument, Map<String,String> xPathMapping)Creates a new workflow node model for aEWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XMLthat changes the value of form elements based on the data of an XML document.static FcImportFormValueFromXmlPropsimportFormValueFromXml(SingleFile xmlDocument, Map<String,String> xPathMapping, Textbaustein xslTemplate)Creates a new workflow node model for aEWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XMLthat changes the value of form elements based on the data of an XML document.static FcLdapQueryPropsldapQuery(LDAPAbfrage ldapQuery)Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYthat uses a preconfigured LDAP query.static FcLdapQueryPropsldapQuery(LDAPAbfrage ldapQuery, Iterable<Map.Entry<String,String>> queryParameters)Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYthat uses a preconfigured LDAP query.static FcLdapQueryPropsldapQuery(LDAPAbfrage ldapQuery, Map<String,String> queryParameters)Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYthat uses a preconfigured LDAP query.static FcLdapQueryPropsldapQuery(LDAPZugriff ldapConnection, String searchFilter)Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYwith a custom search filter.static FcLdapQueryPropsldapQuery(LDAPZugriff ldapConnection, String searchFilter, String baseDn)Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYwith a custom search filter.static FcLdapQueryPropsldapQuery(LDAPZugriff ldapConnection, String searchFilter, String baseDn, Iterable<String> resultFilter)Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYwith a custom search filter.static FcLogEntryPropslogEntry(ELogEntryActionLogLevel level, String comments)Creates a new workflow node model for aEWorkflowNodeType.FC_LOG_ENTRYwith a given level and comments.static FcMoveFormRecordToInboxPropsmoveFormRecordToInbox(Postfach targetInbox)Creates a new workflow node model for aEWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOXthat moves the current form record to the given inbox.static FcMoveFormRecordToInboxPropsmoveFormRecordToInbox(UuidEntityRef targetInbox)Creates a new workflow node model for aEWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOXthat moves the current form record to the given inbox.static FcMoveFormRecordToInboxPropsmoveFormRecordToInbox(String targetInboxName)Creates a new workflow node model for aEWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOXthat moves the current form record to the inbox with the given name.static FcProcessLogPdfPropsprocessLogPdf(String fileName)Creates a new workflow node model for aEWorkflowNodeType.FC_PROCESS_LOG_PDFthat creates a PDF document with the history of the current form record.static FcProvideResourcePropsprovideResource(SingleFile singleFile, String exportName)Creates a new workflow node model for aEWorkflowNodeType.FC_PROVIDE_RESOURCEthat provides the given resource.static FcProvideResourcePropsprovideResource(SingleFile singleFile, String exportName, boolean attachToFormRecord)Creates a new workflow node model for aEWorkflowNodeType.FC_PROVIDE_RESOURCEthat provides the given resource.static FcQueueTaskPropsqueueTask(WorkflowTrigger triggerToInvoke)Creates a new workflow node model for aEWorkflowNodeType.FC_QUEUE_TASKthat invokes the given task immediately after the current task ends.static FcQueueTaskPropsqueueTask(WorkflowTrigger triggerToInvoke, boolean addToEnd)Creates a new workflow node model for aEWorkflowNodeType.FC_QUEUE_TASKthat invokes the given task.static FcRedirectPropsredirect(Textbaustein url)Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.static FcRedirectPropsredirect(Textbaustein url, Map<String,List<String>> queryParameters)Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.static FcRedirectPropsredirect(UuidEntityRef url)Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.static FcRedirectPropsredirect(UuidEntityRef url, Map<String,List<String>> queryParameters)Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.static FcRedirectPropsredirect(String url)Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.static FcRedirectPropsredirect(String url, Map<String,List<String>> queryParameters)Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.static FcRenewProcessIdPropsrenewProcessId()Creates a new workflow node model for aEWorkflowNodeType.FC_RENEW_PROCESS_IDthat generates a new UUID for the form record.static FcReturnFilePropsreturnFile(MultiFile files)Creates a new workflow node model for aEWorkflowNodeType.FC_RETURN_FILEthat sends the given files as the HTTP response.static FcReturnFilePropsreturnFile(MultiFile files, boolean forceDownload)Creates a new workflow node model for aEWorkflowNodeType.FC_RETURN_FILEthat sends the given files as the HTTP response.static FcReturnPropsreturnStatement()Creates a new workflow node model for aEWorkflowNodeType.FC_RETURNthat ends the current workflow task.static FcSaveToFileSystemPropssaveToFileSystem(MultiFile files, String directory)Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEMthat saves the given file to a directory on the file system.static FcSaveToFileSystemPropssaveToFileSystem(MultiFile files, String directory, boolean allowPathInPlaceholder)Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEMthat saves the given file to a directory on the file system.static FcSaveToWebDavPropssaveToWebDav(MultiFile files, WebDavAccess conn, String path)Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_WEB_DAVthat gives the given file to a directory on a chosen WebDAV.static FcSaveToWebDavPropssaveToWebDav(MultiFile files, WebDavAccess conn, String path, boolean allowPathInPlaceholder)Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_WEB_DAVthat gives the given file to a directory on a chosen WebDAV.static FcSetSavedFlagPropssetSavedFlag()Creates a new workflow node model for aEWorkflowNodeType.FC_SET_SAVED_FLAGthat marks the form record as saved or unsaved.static FcShowTemplatePropsshowTemplate(Textbaustein htmlTemplate)Creates a new workflow node model for aEWorkflowNodeType.FC_SHOW_TEMPLATEthat responds to an HTTP request with the given text template.static FcSwitchPropsswitchAction(String switchValue)Creates a new workflow node model for aEWorkflowNodeType.FC_SWITCHthat check a value against several conditions and executes all its matching cases.static FcSwitchCasePropsswitchCase(EMatchCondition operator, String caseValue)Creates a new workflow node model for aEWorkflowNodeType.FC_SWITCH_CASEwith a single condition that is executed when it matches the value of a switch.static FcSwitchDefaultPropsswitchDefault()Creates a new workflow node model for aEWorkflowNodeType.FC_SWITCH_CASEwith a single condition that is executed when it matches the value of a switch.static FcThrowExceptionPropsthrowException(String errorType)Creates a new workflow node model for aEWorkflowNodeType.FC_THROW_EXCEPTIONthat throws an exception when executed.static FcThrowExceptionPropsthrowException(String errorType, String errorMessage)Creates a new workflow node model for aEWorkflowNodeType.FC_THROW_EXCEPTIONthat throws an exception when executed.static FcThrowExceptionPropsthrowException(String errorType, String errorMessage, Object errorData)Creates a new workflow node model for aEWorkflowNodeType.FC_THROW_EXCEPTIONthat throws an exception when executed.static FcWriteFormRecordAttrPropswriteFormRecordAttributes(Map<String,String> attributes)Creates a new workflow node model for aEWorkflowNodeType.FC_WRITE_FORM_RECORD_ATTRIBUTESthat sets custom attributes on the form record.
-
-
-
Method Detail
-
breakStatement
public static FcBreakProps breakStatement()
Creates a new workflow node model for aEWorkflowNodeType.FC_BREAKthat issues a control transfer via a break statement, targeting the closest control flow node.- Returns:
- The workflow node for a break action.
-
breakStatement
public static FcBreakProps breakStatement(NodeKey breakTarget)
Creates a new workflow node model for aEWorkflowNodeType.FC_BREAKthat issues a control transfer via a break statement.- Parameters:
breakTarget- Optional target for the break statement to which to transfer control. If not given, the target is the closest node that supportsbreakcontrol transfers.- Returns:
- The workflow node model for a break action.
-
changeFormAvailability
public static FcChangeFormAvailabilityProps changeFormAvailability(EChangeFormAvailabilityType changeType)
Creates a new workflow node model for aEWorkflowNodeType.FC_CHANGE_FORM_AVAILABILITYthat changes the availability of a form.- Parameters:
changeType- How to modify the form's availability state.- Returns:
- The workflow node model for a change form availability action.
-
changeFormValue
public static FcChangeFormValueProps changeFormValue(Map<String,String> formValues)
Creates a new workflow node model for aEWorkflowNodeType.FC_CHANGE_FORM_VALUEthat modifies the value of one or more form elements.- Parameters:
formValues- Values to set on the form. Key is the name of the form element, value is the new value for the form element.- Returns:
- The workflow node model for a change form value action with the given details.
-
changeState
public static FcChangeStateProps changeState(WorkflowState state)
Creates a new workflow node model for aEWorkflowNodeType.FC_CHANGE_STATEthat changes the current form record to the given state.- Parameters:
state- State to which to change.- Returns:
- The workflow node model for a change state action.
-
compressAsZip
public static FcCompressAsZipProps compressAsZip(MultiFile multiFile, String compressedFileName)
Creates a new workflow node model for aEWorkflowNodeType.FC_COMPRESS_AS_ZIPthat creates a ZIP file form the input files.- Parameters:
multiFile- Files to compress.compressedFileName- File name of the ZIP file.- Returns:
- The workflow node model for a compress as ZIP action.
-
compressAsZip
public static FcCompressAsZipProps compressAsZip(MultiFile multiFile, String compressedFileName, boolean attachToFormRecord)
Creates a new workflow node model for aEWorkflowNodeType.FC_COMPRESS_AS_ZIPthat creates a ZIP file form the input files.- Parameters:
multiFile- Files to compress.compressedFileName- File name of the ZIP file.attachToFormRecord- Whether the ZIP file should be attached to the current form record.- Returns:
- The workflow node model for a compress as ZIP action.
-
compressAsZip
public static FcCompressAsZipProps compressAsZip(MultiFile multiFile, String compressedFileName, boolean attachToFormRecord, ECompressAsZipNamingScheme namingScheme)
Creates a new workflow node model for aEWorkflowNodeType.FC_COMPRESS_AS_ZIPthat creates a ZIP file form the input files.- Parameters:
multiFile- Files to compress.compressedFileName- File name of the ZIP file.attachToFormRecord- Whether the ZIP file should be attached to the current form record.namingScheme- How the files should be named and whether sub directories should be created.- Returns:
- The workflow node model for a compress as ZIP action.
-
continueStatement
public static FcContinueProps continueStatement()
Creates a new workflow node model for aEWorkflowNodeType.FC_CONTINUEthat issues a control transfer via a continue statement, targeting the closest control flow node.- Returns:
- The workflow node for a continue action.
-
continueStatement
public static FcContinueProps continueStatement(NodeKey continueTarget)
Creates a new workflow node model for aEWorkflowNodeType.FC_CONTINUEthat issues a control transfer via a continue statement.- Parameters:
continueTarget- Optional target for the continue statement to which to transfer control. If not given, the target is the closest node that supportscontinuecontrol transfers.- Returns:
- The workflow node model for a continue action.
-
copyFormRecord
public static FcCopyFormRecordProps copyFormRecord(boolean anonymizeUserMetadata)
Creates a new workflow node model for aEWorkflowNodeType.FC_COPY_FORM_RECORDthat moves the current form record to the given inbox.- Parameters:
anonymizeUserMetadata- Whether user metadata should be anonymized in the created protocol entry.- Returns:
- The workflow node model for a copy form record action.
-
copyFormRecord
public static FcCopyFormRecordProps copyFormRecord(boolean anonymizeUserMetadata, WorkflowTrigger triggerToInvoke, Postfach targetInbox)
Creates a new workflow node model for aEWorkflowNodeType.FC_COPY_FORM_RECORDthat moves the current form record to the given inbox.- Parameters:
triggerToInvoke- An optional trigger that is invoked on the copied form record.targetInbox- An optional target inbox to which to move the form record.anonymizeUserMetadata- Whether user metadata should be anonymized in the created protocol entry.- Returns:
- The workflow node model for a copy form record action.
-
counter
public static FcCounterProps counter(ClientCounter counter, ECounterActionType actionType, String step)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat modifies a certain client counter.- Parameters:
counter- Counter to change.actionType- Type how to modify the counter.step- Amount by which to increment or decrement the counter (unused when resetting the counter). May contain variables.- Returns:
- The workflow node model for a counter action.
-
counter
public static FcCounterProps counter(String counterName, ECounterActionType actionType, String step)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat modifies a certain client counter.- Parameters:
counterName- Name of the counter to change.actionType- Type how to modify the counter.step- Amount by which to increment or decrement the counter (unused when resetting the counter). May contain variables.- Returns:
- The workflow node model for a counter action.
-
counterDecrement
public static FcCounterProps counterDecrement(ClientCounter counter, String step)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat decrements a client counter.- Parameters:
counter- Counter to decrement.step- Amount by which to decrement the counter. May contain variables.- Returns:
- The workflow node model for a counter action.
-
counterDecrement
public static FcCounterProps counterDecrement(String counterName, String step)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat decrements a client counter.- Parameters:
counterName- Name of the the counter to decrement.step- Amount by which to decrement the counter. May contain variables.- Returns:
- The workflow node model for a counter action.
-
counterIncrement
public static FcCounterProps counterIncrement(ClientCounter counter, String step)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat increments a client counter.- Parameters:
counter- Counter to increment.step- Amount by which to increment the counter. May contain variables.- Returns:
- The workflow node model for a counter action.
-
counterIncrement
public static FcCounterProps counterIncrement(String counterName, String step)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat increments a client counter.- Parameters:
counterName- Name of the counter to increment.step- Amount by which to increment the counter. May contain variables.- Returns:
- The workflow node model for a counter action.
-
counterReset
public static FcCounterProps counterReset(ClientCounter counter)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat resets a client counter.- Parameters:
counter- Counter to reset.- Returns:
- The workflow node model for a counter action.
-
counterReset
public static FcCounterProps counterReset(String counterName)
Creates a new workflow node model for aEWorkflowNodeType.FC_COUNTERthat resets a client counter.- Parameters:
counterName- Name of the Counter to reset.- Returns:
- The workflow node model for a counter action.
-
createTextFile
public static ICreateTextFileNodeBuilder createTextFile()
Creates a new builder for configuring a workflow node for aEWorkflowNodeType.FC_CREATE_TEXT_FILEthat creates a text file with the given content and the default encoding.- Returns:
- A builder for a workflow node with a create text file action.
-
createTextFile
public static FcCreateTextFileProps createTextFile(String fileName, String fileContent)
Creates a new workflow node model for aEWorkflowNodeType.FC_CREATE_TEXT_FILEthat creates a text file with the given content and the default encoding.- Parameters:
fileName- Name of the created text file.fileContent- Plain text content of the text file.- Returns:
- The workflow node model for a create text file action.
-
databaseQuery
public static FcSqlStatementProps databaseQuery(DatenbankZugriff databaseConnection, String sqlStatement)
Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTwith a SQL statement.- Parameters:
databaseConnection- Database connection to use for the query.sqlStatement- The SQL statement to run against the database connection.- Returns:
- The workflow node model for a database query action.
-
databaseQuery
public static FcSqlStatementProps databaseQuery(Datenquelle databaseQuery)
Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTthat uses a preconfigured database query.- Parameters:
databaseQuery- Existing database query to execute.- Returns:
- The workflow node model for a database query action.
-
databaseQuery
public static FcSqlStatementProps databaseQuery(Datenquelle databaseQuery, Map<String,String> queryParameters)
Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTthat uses a preconfigured database query.- Parameters:
databaseQuery- Existing database query to execute.queryParameters- Query parameters that are passed to the existing query. Must match the parameter count of the database query.- Returns:
- The workflow node model for a database query action.
-
databaseQuery
public static FcSqlStatementProps databaseQuery(Datenquelle databaseQuery, Iterable<Map.Entry<String,String>> queryParameters)
Creates a new workflow node model for aEWorkflowNodeType.FC_SQL_STATEMENTthat uses a preconfigured database query.- Parameters:
databaseQuery- Existing database query to execute.queryParameters- Query parameters that are passed to the existing query. Must match the parameter count of the database query.- Returns:
- The workflow node model for a database query action.
-
decodeBase64
public static FcDecodeBase64Props decodeBase64(String value)
Creates a new workflow node model for aEWorkflowNodeType.FC_ENCODE_BASE64that converts a binary file to base64.- Parameters:
value- Value to decode, a data URI or a base64 string.- Returns:
- The workflow node model for a fill Word action.
-
decodeBase64
public static FcDecodeBase64Props decodeBase64(String value, String exportName, boolean attachToFormRecord)
Creates a new workflow node model for aEWorkflowNodeType.FC_ENCODE_BASE64that converts a binary file to base64.- Parameters:
value- Value to decode, a data URI or a base64 string.exportName- Name of the created file.attachToFormRecord- Whentrue, attaches the created file to the form record.- Returns:
- The workflow node model for a fill Word action.
-
deleteAttachment
public static FcDeleteAttachmentProps deleteAttachment(MultiAttachment attachmentsToDelete)
Creates a new workflow node model for aEWorkflowNodeType.FC_DELETE_ATTACHMENTthat deletes attachments from the current form record.- Parameters:
attachmentsToDelete- Attachments to delete from the form record.- Returns:
- The workflow node model for a delete attachment action.
-
deleteFormRecord
public static FcDeleteFormRecordProps deleteFormRecord()
Creates a new workflow node model for aEWorkflowNodeType.FC_DELETE_FORM_RECORDthat deletes the current form record when executed.- Returns:
- The workflow node model for a delete form record action.
-
doiInit
public static FcDoiInitProps doiInit(String from, Iterable<String> to, String subject, String htmlBody, String plainTextBody, Textbaustein doiFailTemplate)
Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.htmlBody- HTML body content of the email,nullor empty to omit the HTML body.plainTextBody- Plain text body content of the email,nullor empty to omit the plain text body.doiFailTemplate- Template used when the double opt-in link fails.- Returns:
- The workflow node model for a double opt-in initialization action.
-
doiInitHtml
public static FcDoiInitProps doiInitHtml(String from, Iterable<String> to, String subject, String body)
Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- HTML body of the email.- Returns:
- The workflow node model for a double opt-in initialization action.
-
doiInitHtml
public static FcDoiInitProps doiInitHtml(String from, Iterable<String> to, String subject, String body, Textbaustein doiFailTemplate)
Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- HTML body of the email.doiFailTemplate- Template used when the double opt-in link fails.- Returns:
- The workflow node model for a double opt-in initialization action.
-
doiInitPlain
public static FcDoiInitProps doiInitPlain(String from, Iterable<String> to, String subject, String body)
Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- Plain text body of the email.- Returns:
- The workflow node model for a double opt-in initialization action.
-
doiInitPlain
public static FcDoiInitProps doiInitPlain(String from, Iterable<String> to, String subject, String body, Textbaustein doiFailTemplate)
Creates a new workflow node model for aEWorkflowNodeType.FC_DOI_INITthat initializes the double opt-in process.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- Plain text body of the email.doiFailTemplate- Template used when the double opt-in link fails.- Returns:
- The workflow node model for a double opt-in initialization action.
-
email
public static IEmailNodeBuilder email(String from)
Creates a builder for a new workflow node for aEWorkflowNodeType.FC_EMAILthat sends an email to a given list of recipients.- Parameters:
from- Mail address of the sender.- Returns:
- A builder for configuring the details of the post request action.
-
email
public static FcEmailProps email(String from, Iterable<String> to, String subject, String htmlBody, String plainTextBody)
Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an email to one or more recipients.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.htmlBody- HTML body content of the email,nullto omit the HTML body.plainTextBody- Plain text body content of the email,nullto omit the plain text body.- Returns:
- The workflow node model for an email action.
-
email
public static FcEmailProps email(String from, Iterable<String> to, String subject, String htmlBody, String plainTextBody, MultiFile attachments)
Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an email to one or more recipients.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.htmlBody- HTML body content of the email,nullto omit the HTML body.plainTextBody- Plain text body content of the email,nullto omit the plain text body.attachments- Attachments to send with the email.- Returns:
- The workflow node model for an email action.
-
emailHtml
public static FcEmailProps emailHtml(String from, Iterable<String> to, String subject, String body)
Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an HTML email to one or more recipients.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- Body of the email.- Returns:
- The workflow node model for an email action.
-
emailHtml
public static FcEmailProps emailHtml(String from, Iterable<String> to, String subject, String body, MultiFile attachments)
Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends an HTML email to one or more recipients.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- Body of the email.attachments- Attachments to send with the email.- Returns:
- The workflow node model for an email action.
-
emailPlainText
public static FcEmailProps emailPlainText(String from, Iterable<String> to, String subject, String body)
Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends a plain text email to one or more recipients.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- Body of the email.- Returns:
- The workflow node model for an email action.
-
emailPlainText
public static FcEmailProps emailPlainText(String from, Iterable<String> to, String subject, String body, MultiFile attachments)
Creates a new workflow node model for aEWorkflowNodeType.FC_EMAILthat sends a plain text email to one or more recipients.- Parameters:
from- Email address of the sender.to- Email addresses of the recipients.subject- Subject to of the email.body- Body of the email.attachments- Attachments to send with the email.- Returns:
- The workflow node model for an email action.
-
encodeBase64
public static FcEncodeBase64Props encodeBase64(SingleFile file)
Creates a new workflow node model for aEWorkflowNodeType.FC_ENCODE_BASE64that converts a binary file to base64.- Parameters:
file- File to encode.- Returns:
- The workflow node model for a encode base64 action.
-
exportFormRecordChats
public static FcExportFormRecordChatsProps exportFormRecordChats(String fileName)
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATSthat exports the chat history of a form record to a PDF document.- Parameters:
fileName- Name of the output file with the created PDF document.- Returns:
- The workflow node model for an export form record chats action.
-
exportFormRecordChats
public static FcExportFormRecordChatsProps exportFormRecordChats(String exportName, boolean attachToFormRecord)
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATSthat creates a export file with the chat history of a form record.- Parameters:
exportName- Name of the created chat history file. Leave empty for an automatically generated name.attachToFormRecord- Whentrue, attaches the created file to the form record.- Returns:
- The workflow node model for an export form record chats action.
-
exportFormRecordChats
public static FcExportFormRecordChatsProps exportFormRecordChats()
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates an export file with the chat history of a form record. The file name is generated automatically. The file is not attached to the form record.- Returns:
- The workflow node model for an export form record chats action.
-
exportToPersistence
public static FcExportToPersistenceProps exportToPersistence()
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data. The file name is generated automatically and the file is not attached to the form record.- Returns:
- The workflow node model for an export to persistence action.
-
exportToPersistence
public static FcExportToPersistenceProps exportToPersistence(String exportName)
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data. The file is not attached to the form record.- Parameters:
exportName- Name of the created persistence file. Leave empty for an automatically generated name.- Returns:
- The workflow node model for an export to persistence action.
-
exportToPersistence
public static FcExportToPersistenceProps exportToPersistence(String exportName, boolean attachToFormRecord)
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.- Parameters:
exportName- Name of the created persistence file. Leave empty for an automatically generated name.attachToFormRecord- Whentrue, attaches the created file to the form record.- Returns:
- The workflow node model for an export to persistence action.
-
exportToXml
public static FcExportToXmlProps exportToXml()
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data. The file name is generated automatically and the file is not attached to the form record. All additionalEExportToXmlFields are included.- Returns:
- The workflow node model for an export to persistence action.
-
exportToXml
public static FcExportToXmlProps exportToXml(String exportName)
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data. The file is not attached to the form record. All additionalEExportToXmlFields are included.- Parameters:
exportName- Name of the created persistence file. Leave empty for an automatically generated name.- Returns:
- The workflow node model for an export to persistence action.
-
exportToXml
public static FcExportToXmlProps exportToXml(String exportName, boolean attachToFormRecord)
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data. All additionalEExportToXmlFields are included.- Parameters:
exportName- Name of the created persistence file. Leave empty for an automatically generated name.attachToFormRecord- Whentrue, attaches the created file to the form record.- Returns:
- The workflow node model for an export to persistence action.
-
exportToXml
public static FcExportToXmlProps exportToXml(String exportName, boolean attachToFormRecord, Iterable<EExportToXmlField> exportFields, Textbaustein xslTemplate)
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPORT_TO_PERSISTENCEthat creates a persistence file with the submitted form data.- Parameters:
exportName- Name of the created persistence file. Leave empty for an automatically generated name.attachToFormRecord- Whentrue, attaches the created file to the form record.exportFields- Additional fields that should be included in the exported file.xslTemplate- Optional XSL template for transforming the created XML file.- Returns:
- The workflow node model for an export to persistence action.
-
fillPdf
public static FcFillPdfProps fillPdf(SingleFile pdfDocument)
Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_PDFthat fills a PDF document with the submitted form data. The file name of the created PDF document is generated automatically. The create file is not attached to the form record.- Parameters:
pdfDocument- PDF document to fill.- Returns:
- The workflow node model for a fill PDF action.
-
fillPdf
public static FcFillPdfProps fillPdf(SingleFile pdfDocument, String exportName, boolean attachToFormRecord, String font)
Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_PDFthat fills a PDF document with the submitted form data.- Parameters:
pdfDocument- PDF document to fill.exportName- Name of the created PDF file. Leave empty for an automatically generated name.attachToFormRecord- Whentrue, attaches the created file to the form record.font- The font to use within the PDF for the inserted values.- Returns:
- The workflow node model for a fill PDF action.
-
fillWord
public static FcFillWordProps fillWord(SingleFile wordDocument)
Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_WORDthat fills a Word document with the submitted form data. The name of the created file is generated automatically. The created file is not attached to the form record.- Parameters:
wordDocument- Word document to fill.- Returns:
- The workflow node model for a fill Word action.
-
fillWord
public static FcFillWordProps fillWord(SingleFile wordDocument, String exportName, boolean attachToFormRecord)
Creates a new workflow node model for aEWorkflowNodeType.FC_FILL_WORDthat fills a Word document with the submitted form data.- Parameters:
wordDocument- Word document to fill.exportName- Name of the created file. Should end on either.pdfor.docx. Leave empty for an automatically generated name.attachToFormRecord- Whentrue, attaches the created file to the form record.- Returns:
- The workflow node model for a fill Word action.
-
httpRequest
public static IHttpRequestNodeBuilder httpRequest(EHttpVerb httpVerb, String endpointUrl)
Creates a builder for a new workflow node for aEWorkflowNodeType.FC_POST_REQUESTthat sends an HTTP request to the given URL.- Parameters:
httpVerb- HTTP verb to use, such asGETorPOST.endpointUrl- URL to which to direct the HTTP request.- Returns:
- A builder for configuring the details of the post request action.
-
httpRequest
public static IHttpRequestNodeBuilder httpRequest(String httpVerb, String endpointUrl)
Creates a builder for a new workflow node for aEWorkflowNodeType.FC_POST_REQUESTthat sends an HTTP request to the given URL.- Parameters:
httpVerb- HTTP verb to use, such asGETorPOST.endpointUrl- URL to which to direct the HTTP request.- Returns:
- A builder for configuring the details of the post request action.
-
importFormValueFromXml
public static FcImportFormValueFromXmlProps importFormValueFromXml(SingleFile xmlDocument, Map<String,String> xPathMapping)
Creates a new workflow node model for aEWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XMLthat changes the value of form elements based on the data of an XML document.- Parameters:
xmlDocument- XML document with the data to use.xPathMapping- A map between the name of a form element and an XPath. The value of the form element is set to the data in the XML document at the given XPath.- Returns:
- The workflow node model for a import form values from XML action.
-
importFormValueFromXml
public static FcImportFormValueFromXmlProps importFormValueFromXml(SingleFile xmlDocument, Map<String,String> xPathMapping, Textbaustein xslTemplate)
Creates a new workflow node model for aEWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XMLthat changes the value of form elements based on the data of an XML document.- Parameters:
xmlDocument- XML document with the data to use.xPathMapping- A map between the name of a form element and an XPath. The value of the form element is set to the data in the XML document at the given XPath.xslTemplate- Optional XSLT document applied to the XML document before data is extracted via the given XPaths.- Returns:
- The workflow node model for a import form values from XML action.
-
ldapQuery
public static FcLdapQueryProps ldapQuery(LDAPAbfrage ldapQuery)
Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYthat uses a preconfigured LDAP query.- Parameters:
ldapQuery- Existing LDAP query to execute.- Returns:
- The workflow node model for an LDAP query action.
-
ldapQuery
public static FcLdapQueryProps ldapQuery(LDAPAbfrage ldapQuery, Map<String,String> queryParameters)
Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYthat uses a preconfigured LDAP query.- Parameters:
ldapQuery- Existing LDAP query to execute.queryParameters- Query parameters that are passed to the existing query. Must match the parameter count of the LDAP query.- Returns:
- The workflow node model for an LDAP query action.
-
ldapQuery
public static FcLdapQueryProps ldapQuery(LDAPAbfrage ldapQuery, Iterable<Map.Entry<String,String>> queryParameters)
Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYthat uses a preconfigured LDAP query.- Parameters:
ldapQuery- Existing LDAP query to execute.queryParameters- Query parameters that are passed to the existing query. Must match the parameter count of the LDAP query.- Returns:
- The workflow node model for an LDAP query action.
-
ldapQuery
public static FcLdapQueryProps ldapQuery(LDAPZugriff ldapConnection, String searchFilter)
Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYwith a custom search filter.- Parameters:
ldapConnection- LDAP connection to use for the query. Whennull, the client LDAP connection is used.searchFilter- The LDAP search filter expression.- Returns:
- The workflow node model for an LDAP query action.
-
ldapQuery
public static FcLdapQueryProps ldapQuery(LDAPZugriff ldapConnection, String searchFilter, String baseDn)
Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYwith a custom search filter.- Parameters:
ldapConnection- LDAP connection to use for the query. Whennull, the client LDAP connection is used.searchFilter- The LDAP search filter expression.baseDn- Base DN for the LDAP search.- Returns:
- The workflow node model for an LDAP query action.
-
ldapQuery
public static FcLdapQueryProps ldapQuery(LDAPZugriff ldapConnection, String searchFilter, String baseDn, Iterable<String> resultFilter)
Creates a new workflow node model for aEWorkflowNodeType.FC_LDAP_QUERYwith a custom search filter.- Parameters:
ldapConnection- LDAP connection to use for the query. Whennull, the client LDAP connection is used.searchFilter- The LDAP search filter expression.baseDn- Base DN for the LDAP search.resultFilter- Result filter to limit the returned data to these attributes.- Returns:
- The workflow node model for an LDAP query action.
-
logEntry
public static FcLogEntryProps logEntry(ELogEntryActionLogLevel level, String comments)
Creates a new workflow node model for aEWorkflowNodeType.FC_LOG_ENTRYwith a given level and comments.- Parameters:
level- The severity of the log entry.comments- The comments for the log entry (custom description)- Returns:
- A new workflow node of the given type and with the given data.
-
moveFormRecordToInbox
public static FcMoveFormRecordToInboxProps moveFormRecordToInbox(UuidEntityRef targetInbox)
Creates a new workflow node model for aEWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOXthat moves the current form record to the given inbox.- Parameters:
targetInbox- Target inbox to which to move the form record.- Returns:
- The workflow node model for a move form record to inbox action.
-
moveFormRecordToInbox
public static FcMoveFormRecordToInboxProps moveFormRecordToInbox(Postfach targetInbox)
Creates a new workflow node model for aEWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOXthat moves the current form record to the given inbox.- Parameters:
targetInbox- Target inbox to which to move the form record.- Returns:
- The workflow node model for a move form record to inbox action.
-
moveFormRecordToInbox
public static FcMoveFormRecordToInboxProps moveFormRecordToInbox(String targetInboxName)
Creates a new workflow node model for aEWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOXthat moves the current form record to the inbox with the given name.- Parameters:
targetInboxName- Name of the target inbox to which to move the form record.- Returns:
- The workflow node model for a move form record to inbox action.
-
processLogPdf
public static FcProcessLogPdfProps processLogPdf(String fileName)
Creates a new workflow node model for aEWorkflowNodeType.FC_PROCESS_LOG_PDFthat creates a PDF document with the history of the current form record.- Parameters:
fileName- Name of the output file with the created PDF document.- Returns:
- The workflow node model for a form record history action.
-
provideResource
public static FcProvideResourceProps provideResource(SingleFile singleFile, String exportName)
Creates a new workflow node model for aEWorkflowNodeType.FC_PROVIDE_RESOURCEthat provides the given resource.- Parameters:
singleFile- Resource that is made available by the action. Use the static factory methods provided bySingleFileto create an instance.exportName- Name of the file that is created by the action.- Returns:
- The workflow node model for a provide resource action.
-
provideResource
public static FcProvideResourceProps provideResource(SingleFile singleFile, String exportName, boolean attachToFormRecord)
Creates a new workflow node model for aEWorkflowNodeType.FC_PROVIDE_RESOURCEthat provides the given resource.- Parameters:
singleFile- Resource that is made available by the action. Use the static factory methods provided bySingleFileto create an instance.exportName- Name of the file that is created by the action.attachToFormRecord- Whether the provided file should be attached to the current form record.- Returns:
- The workflow node model for a provide resource action.
-
queueTask
public static FcQueueTaskProps queueTask(WorkflowTrigger triggerToInvoke)
Creates a new workflow node model for aEWorkflowNodeType.FC_QUEUE_TASKthat invokes the given task immediately after the current task ends.- Parameters:
triggerToInvoke- Trigger to invoke. Should be of typeEWorkflowTriggerType.FC_MANUAL.- Returns:
- The workflow node model for a queue task action.
-
queueTask
public static FcQueueTaskProps queueTask(WorkflowTrigger triggerToInvoke, boolean addToEnd)
Creates a new workflow node model for aEWorkflowNodeType.FC_QUEUE_TASKthat invokes the given task.- Parameters:
triggerToInvoke- Trigger to invoke. Should be of typeEWorkflowTriggerType.FC_MANUAL.addToEnd- Whentrue, the task is added to the end of the task queue. Otherwise, the task is added at the beginning of the task queue (and will be executed once this task finishes).- Returns:
- The workflow node model for a queue task action.
-
redirect
public static FcRedirectProps redirect(String url)
Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.- Parameters:
url- URL to which to redirect.- Returns:
- The workflow node model for a redirect action.
-
redirect
public static FcRedirectProps redirect(String url, Map<String,List<String>> queryParameters)
Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.- Parameters:
url- URL to which to redirect.queryParameters- Additional query parameters for the URL.- Returns:
- The workflow node model for a redirect action.
-
redirect
public static FcRedirectProps redirect(Textbaustein url)
Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.- Parameters:
url- URL to which to redirect.- Returns:
- The workflow node model for a redirect action.
-
redirect
public static FcRedirectProps redirect(Textbaustein url, Map<String,List<String>> queryParameters)
Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.- Parameters:
url- URL to which to redirect.queryParameters- Additional query parameters for the URL.- Returns:
- The workflow node model for a redirect action.
-
redirect
public static FcRedirectProps redirect(UuidEntityRef url)
Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.- Parameters:
url- Reference to a URL template to which to redirect.- Returns:
- The workflow node model for a redirect action.
-
redirect
public static FcRedirectProps redirect(UuidEntityRef url, Map<String,List<String>> queryParameters)
Creates a new workflow node model for aEWorkflowNodeType.FC_REDIRECTthat redirects the HTTP request to the given URL.- Parameters:
url- Reference to a URL template to which to redirect.queryParameters- Additional query parameters for the URL.- Returns:
- The workflow node model for a redirect action.
-
renewProcessId
public static FcRenewProcessIdProps renewProcessId()
Creates a new workflow node model for aEWorkflowNodeType.FC_RENEW_PROCESS_IDthat generates a new UUID for the form record.- Returns:
- The workflow node model for a renew process ID action.
-
returnFile
public static FcReturnFileProps returnFile(MultiFile files)
Creates a new workflow node model for aEWorkflowNodeType.FC_RETURN_FILEthat sends the given files as the HTTP response.- Parameters:
files- Files to send.- Returns:
- The workflow node model for a return file action.
-
returnFile
public static FcReturnFileProps returnFile(MultiFile files, boolean forceDownload)
Creates a new workflow node model for aEWorkflowNodeType.FC_RETURN_FILEthat sends the given files as the HTTP response.- Parameters:
files- Files to send.forceDownload- Iftrue, sets theContent-Dispositionheader toattachment, so that the browser does not show the file inline.- Returns:
- The workflow node model for a return file action.
-
saveToFileSystem
public static FcSaveToFileSystemProps saveToFileSystem(MultiFile files, String directory)
Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEMthat saves the given file to a directory on the file system.- Parameters:
files- Files to save to the file system.directory- Path to a directory on the file system.- Returns:
- The workflow node model for a save to file system action.
-
saveToFileSystem
public static FcSaveToFileSystemProps saveToFileSystem(MultiFile files, String directory, boolean allowPathInPlaceholder)
Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEMthat saves the given file to a directory on the file system.- Parameters:
files- Files to save to the file system.directory- Path to a directory on the file system.allowPathInPlaceholder- Whentrue, paths (forward or backward slashes) are allowed in the values of placeholders. Whenfalse, placeholder values are sanitized so that they are valid file names.- Returns:
- The workflow node model for a save to file system action.
-
saveToWebDav
public static FcSaveToWebDavProps saveToWebDav(MultiFile files, WebDavAccess conn, String path)
Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_WEB_DAVthat gives the given file to a directory on a chosen WebDAV.- Parameters:
files- Files to save to a chosen WebDAV.conn- aWebDavAccessconnection.path- the chosen path extending the pre-saved url.- Returns:
- The workflow node model for a save to WebDAV action.
-
saveToWebDav
public static FcSaveToWebDavProps saveToWebDav(MultiFile files, WebDavAccess conn, String path, boolean allowPathInPlaceholder)
Creates a new workflow node model for aEWorkflowNodeType.FC_SAVE_TO_WEB_DAVthat gives the given file to a directory on a chosen WebDAV.- Parameters:
files- Files to save to a chosen WebDAV.conn- aWebDavAccessconnection.path- the chosen path extending the pre-saved url.allowPathInPlaceholder- Whentrue, paths (forward or backward slashes) are allowed in the values of placeholders. Whenfalse, placeholder values are sanitized so that they are valid file names.- Returns:
- The workflow node model for a save to WebDAV action.
-
setSavedFlag
public static FcSetSavedFlagProps setSavedFlag()
Creates a new workflow node model for aEWorkflowNodeType.FC_SET_SAVED_FLAGthat marks the form record as saved or unsaved.- Returns:
- The workflow node model for a set saved flag action.
-
showTemplate
public static FcShowTemplateProps showTemplate(Textbaustein htmlTemplate)
Creates a new workflow node model for aEWorkflowNodeType.FC_SHOW_TEMPLATEthat responds to an HTTP request with the given text template.- Parameters:
htmlTemplate- A text template to show that should be of typeETextbausteinKategorie.HTML.- Returns:
- The workflow node model for a show template action.
-
writeFormRecordAttributes
public static FcWriteFormRecordAttrProps writeFormRecordAttributes(Map<String,String> attributes)
Creates a new workflow node model for aEWorkflowNodeType.FC_WRITE_FORM_RECORD_ATTRIBUTESthat sets custom attributes on the form record.- Parameters:
attributes- Attributes (key value pairs) to set on the form record.- Returns:
- The workflow node model for a throw exception action.
-
experiment
public static FcExperimentProps experiment()
Creates a new workflow node model for aEWorkflowNodeType.FC_EXPERIMENTthat catches exception that occur while the block is executed.- Returns:
- The workflow node model for an experiment action.
-
returnStatement
public static FcReturnProps returnStatement()
Creates a new workflow node model for aEWorkflowNodeType.FC_RETURNthat ends the current workflow task.- Returns:
- The workflow node model for a return action.
-
switchAction
public static FcSwitchProps switchAction(String switchValue)
Creates a new workflow node model for aEWorkflowNodeType.FC_SWITCHthat check a value against several conditions and executes all its matching cases.- Parameters:
switchValue- Value to check against the switch cases.- Returns:
- The workflow node model for a switch action.
-
switchCase
public static FcSwitchCaseProps switchCase(EMatchCondition operator, String caseValue)
Creates a new workflow node model for aEWorkflowNodeType.FC_SWITCH_CASEwith a single condition that is executed when it matches the value of a switch.- Parameters:
operator- Type of the condition.caseValue- Value to compare against the switch value via the given operator.- Returns:
- The workflow node model for a switch case action.
-
switchDefault
public static FcSwitchDefaultProps switchDefault()
Creates a new workflow node model for aEWorkflowNodeType.FC_SWITCH_CASEwith a single condition that is executed when it matches the value of a switch.- Returns:
- The workflow node model for a switch case action.
-
throwException
public static FcThrowExceptionProps throwException(String errorType)
Creates a new workflow node model for aEWorkflowNodeType.FC_THROW_EXCEPTIONthat throws an exception when executed.- Parameters:
errorType- Type of the exception to throw.- Returns:
- The workflow node model for a throw exception action.
-
throwException
public static FcThrowExceptionProps throwException(String errorType, String errorMessage)
Creates a new workflow node model for aEWorkflowNodeType.FC_THROW_EXCEPTIONthat throws an exception when executed.- Parameters:
errorType- Type of the exception to throw.errorMessage- Message of the exception to throw.- Returns:
- The workflow node model for a throw exception action.
-
throwException
public static FcThrowExceptionProps throwException(String errorType, String errorMessage, Object errorData)
Creates a new workflow node model for aEWorkflowNodeType.FC_THROW_EXCEPTIONthat throws an exception when executed.- Parameters:
errorType- Type of the exception to throw.errorMessage- Message of the exception to throw.errorData- Additional data to make available when the exception is thrown. Can be accessed when the exception is caught.- Returns:
- The workflow node model for a throw exception action.
-
createCustomSetting
protected static Setting<String> createCustomSetting(String name, String value, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)
-
createCustomSettings
protected static List<Setting<String>> createCustomSettings(Map<String,String> map, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)
-
createCustomSettings
protected static List<Setting<String>> createCustomSettings(Iterable<Map.Entry<String,String>> map, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)
-
createCustomSettingsMultiValues
protected static List<Setting<String>> createCustomSettingsMultiValues(Map<String,List<String>> map, boolean nameEditable, boolean valueEditable, boolean required, boolean deletable)
-
-