All Classes and Interfaces
Class
Description
Deprecated.
Use the new workflow engine.
Describes the closing hours of an
AppointmentTemplate.The view model for the
AAppointmentClosingTime.Exception class for the various kinds of
EAttachmentItemResolutionErrors with additional data.Abstract class for all errors specific to an attachment item.
Exception data class for the
EAttachmentItemResolutionError.ATTACHMENT_COUNT_REDUCED_TO_ZERO_BY_FILTER_OPTIONS error.Exception data class for the
EAttachmentItemResolutionError.ATTACHMENT_QUERY_DOES_NOT_MATCH error.Exception data class for the
EAttachmentItemResolutionError.CANNOT_PROCESS_ATTACHMENT_ITEM error.Exception data class for the
EAttachmentItemResolutionError.CANNOT_PROCESS_ATTACHMENT_LIST error.Exception data class for the
EAttachmentItemResolutionError.DATABASE_ERROR error.Exception data class for the
EAttachmentItemResolutionError.FILE_SYSTEM_ERROR error.Exception data class for the
EAttachmentItemResolutionError.NODE_DOES_NOT_EXIST error.Exception data class for the
EAttachmentItemResolutionError.NODE_DOES_NOT_PROVIDE_ATTACHMENTS error.Exception data class for the
EAttachmentItemResolutionError.NODE_NOT_EXECUTED error.Exception data class for the
EAttachmentItemResolutionError.UPLOAD_FIELD_DOES_NOT_EXIST error.Exception data class for the
EAttachmentItemResolutionError.UPLOAD_FIELD_DOES_NOT_PROVIDE_ATTACHMENTS
error.AAuthenticator<T extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>
Abstract base class for user authenticators
Abstract base class for authenticator configurations
Deprecated.
Inject beans directly via
@Inject, use helper classes and static methods directly.Base class for backend push contexts (web sockets) with some utility methods for commonly used message, such as
requesting an AJAX update or invoking a remote command.
ABasicResourceBean<E extends IFileDataEntity<?>,T extends IFileProviding<?,E> & INameProviding & IDescriptionProviding>
Base bean for multiple condition UIs.
Indicates that execution of a workflow node ended abruptly.
A simple builder for an
AbstractAbruptCompletionExceptionDeprecated.
use
AFileEntityDeprecated.
use
AFileDataEntityDiese Klasse ist die Elternklasse aller Entitäten und beinhaltet die Attribute, die in jeder Entität vorhanden sein
müssen.
Diese Klasse ist die Elternklasse aller Entitäten und beinhaltet die Attribute, die in jeder Entität vorhanden sein
müssen.
Deprecated.
This is part of the old rest API.
Diese Klasse ist die Superklasse von denen alle neudefinierten Exceptions erben sollen.
Diese Klasse ist die Superklasse von denen alle neudefinierten Exceptions erben sollen.
When a resource or page was found, but access was denied.
Deprecated.
Deprecated.
Abstract base class for authorizations of a
MandantA supplier for a list of filter criteria that should be applied when searching the database for matching entities.
Sorting criterion base on
AttributeSelectCriteriaManager.Referenz Implementierung für die
IPluginConfigParam - SchnittstelleAbstract base class for authenticator config view models
Deprecated.
Use the new workflow engine.
Deprecated.
Deprecated.
Wrapper for a
Graphics2D instance that disposes of the instance automatically when closed.Model for when a trigger or node is selected and its details need to be shown in the properties panel.
Abstract base class for data query servlets
A data sheet for two dimensional data.
Abstract base class for data source servlets
Deprecated.
Use
ADataQueryServlet insteadDeprecated.
Use
ADataSourceServlet insteadGenerates new
ProjectAuthenticatorConfigs based on the old authentication configuration of a ProjektCustom change for
Liquibase to generate UUIDs using the formcycle internal UUID generatorPOJO model with the data for adding a new state in the workflow designer.
Request a new state to be added to the workflow.
POJO response data for
AddNewStateRequest.Helper class for generating the data for the workflow element info panel.
Deprecated.
Abstract class with diffrent CRUD operations for entities of the type
ITransferableEntity.Abstract bean base class for displaying or editing the details of a single entity
Abstract base class for entity exporters
Configuration class for entity imports
Abstract base class for entity view models
Base class for tests that want to test the workflow event runner, such as tests for specific triggers.
Deprecated.
Deprecated.
class will be removed.
Utilities for
affine transformations.Exception class for the various kinds of
EResourceItemResolutionErrors with additional data.Abstract class for all errors specific to a resource item.
Exception data class for the
EResourceItemResolutionError.ATTACHMENT_QUERY_DOES_NOT_MATCH error.Exception data class for the
EResourceItemResolutionError.CANNOT_PROCESS_FILE_LIST error.Exception data class for the
EResourceItemResolutionError.CANNOT_PROCESS_RESOURCE_ITEM error.Exception data class for the
EResourceItemResolutionError.CLIENT_FILE_DOES_NOT_EXIST error.Exception data class for the
EResourceItemResolutionError.DATABASE_ERROR error.Exception data class for the
EResourceItemResolutionError.EXTERNAL_URL_CANNOT_BE_READ error.Exception data class for the
EResourceItemResolutionError.EXTERNAL_URL_IS_SYNTACTICALLY_INVALID error.Exception data class for the
EResourceItemResolutionError.FILE_COUNT_REDUCED_TO_ZERO_BY_FILTER_OPTIONS
error.Exception data class for the
EResourceItemResolutionError.FILE_SYSTEM_ERROR error.Exception data class for the
EResourceItemResolutionError.FORM_FILE_DOES_NOT_EXIST error.Exception data class for the
EResourceItemResolutionError.NODE_DOES_NOT_EXIST error.Exception data class for the
EResourceItemResolutionError.NODE_DOES_NOT_PROVIDE_FILES error.Exception data class for the
EResourceItemResolutionError.NODE_NOT_EXECUTED error.Exception data class for the
EResourceItemResolutionError.UPLOAD_FIELD_DOES_NOT_EXIST error.Exception data class for the
EResourceItemResolutionError.UPLOAD_FIELD_DOES_NOT_PROVIDE_FILES error.A watcher that runs an action each time at least one of the watched files have changed.
Base class for workflow-servtes.
POJO base class implementing the methods of
IFormRecordProvidingEvent.Abstract base class for form record wrappers
Abstract base class for generating form share scripts
A
ResourceBundle that combines multiple different resource bundles.Base class for implementing
IHandlerProvider for both the master and the frontend server.Base test for interface tests that check whether the contract of an interface has changed.
POJO data model for the push event beans.
Simple builder for creating a
AjaxCallPushData.Details with meta data for an AJAX upload, see also
AjaxUploadManager.Simple builder for an
AjaxUploadDetails instance.When an error occurred in the AJAX upload servlet.
Manages the files uploaded via AJAX before the form was submitted.
POJO for a single AJAX upload add or removal request.
Servlet for the AJAX upload feature.
Parameters for the
addUpload sub request type of the AjaxUploadServlet.Deprecated.
Inject beans directly via
@Inject, use helper classes and static methods directly.Additional options for
AJSFContext.redirect(String, RedirectOptions).Deprecated.
This entity is part of the old workflow engine.
Deprecated.
Use
WorkflowNodeAPI and the new workflow engine.Deprecated.
Deprecated.
This is part of the old workflow engine, use the new workflow engine, e.g.
Deprecated.
The old workflow engine will be removed, use the new workflow engine.
Deprecated.
This is part of the old rest API.
Deprecated.
The new user managemen uses the system-scoped
UserProfile, the client-scoped
DirectClientAuthorization etc.Deprecated.
This is part of the old rest API.
Deprecated.
Diese Klasse ist die Elternklasse aller Entitäten und beinhaltet die Attribute, die in jeder Entität vorhanden sein
müssen.
Deprecated.
Use the static methods from
MessageUtils directly.Diese Klasse bildet den Rahmen für die Meta-Daten die einem Formular angefügt werden können.
View model for authenticator configs of type
EAuthClientType.ANONYMOUSWrapper for authenticator configs of type
EAuthClientType.ANONYMOUSDeprecated.
Use
AnonymousClient instead.Wrapper for virtual authenticator config for anyone.
Deprecated.
This is part of the old workflow engine.
Mixin to simplify CRUD (create-read-update-delete) operations on entities implemented via the
Configuration.ApiProvider
layer .API-Provider-Klasse welche alle verfügbaren Unter-APIs zur instanziiert zur Verfügung stellt
Current settings of the API.
Abstract base class meant for
IPluginWorkflowNode plugins that only wish to provide a workflow action that
executes some business logic.Base class for the bean of a
IPluginClientDashboard.Abstract base class meant for
IPluginWorkflowNode plugins that only wish to provide a workflow condition that
executes some business logic condition.Deprecated.
Use the new workflow engine, see e.g.
APluginEntity<META extends IPluginFileEntity<?,?,?>,DATA extends IFileDataEntity<META>,CONFIG extends IFileDataEntity<META>>
A formcycle plugin that provides additional features to an existing formcycle application.
APluginFileEntity<T extends IPluginEntity<?,?,?>,J extends IFileDataEntity<?>,C extends IFileDataEntity<?>>
The base class for the bean of a plugin with a custom UI.
Base class for
IPluginServletAction which provides a basic implementation for a servlet action that provides
static resources.Abstract base class meant for
IPluginWorkflowTrigger plugins that only wish to provide a workflow action that
executes some business logic.Bean for configuring settings of the application properties file.
Bean for event subscription and handling during session
Default implementation of
ITriggerAppliesToEventParams.Describes a booked appointment.
API class for reading and writing
Appointment entities.Implementation of a
IAppointmentAvailableDate.Exception thrown by the appointment booking handler.
Executor with the logic for booking appointments, canceling appointments, or moving appointments to another date.
POJO implementation of
IAppointmentBookingParams with a builder.Describes the closing hours of an
AppointmentTemplate.Implementation of the
IAppointmentClientClosingTimeDao for reading and writing
AppointmentClientClosingTime entities.The view model for the
AppointmentClientClosingTime.Describes the closing hours of an
AppointmentTemplate.Implementation of the
IAppointmentClosingTimeDao for reading and writing AppointmentClosingTime
entities.The view model for the
AppointmentClosingTime.Converts between the timestamp / ID representation of an appointment and the appointment itself.
POJO implementation of
IAppointmentCreateBookingParams with a builder.Implementation of the
IAppointmentDao for reading and writing Appointment entities.POJO implementation of
IAppointmentData.Class for creating the data of an ical entry
POJO implementation of
IAppointmentDeleteBookingParams with a builder.POJO view for the
AttributeSelectCriteriaManager when loading data in the inbox.Bean that keeps a list of available appointment tempplates, shown in the sidebar menu to the left.
POJO implementation of a
IAppointmentFreeSlot.POJO implementation of a
IAppointmentFreeSlotQueryParams.Filter converting a
IAppointmentFreeSlotQueryResult to the appropriate JSON object that is returned by the
AppointmentFreeSlotsServlet.Servlet for the appointment feature.
Represents the parsed parameters of a request to the
AppointmentFreeSlotsServlet.Handler implementation for reading and writing
Appointment entities.Helper methods for the appointment module.
Exception thrown by the iCal query executor that creates calendars for appointments.
Simple POJO implementation of a
IAppointmentIcalQueryResult.Servlet for the appointment feature.
Represents the parameters of the
AppointmentIcalServlet.Builder for creating ical links to calendars.
Builder for creating an html appointment list
POJO implementation of
IAppointmentMoveBookingParams with a builder.Builder for persisting appointments of a
Vorgang.POJO implementation with builder for
IAppointmentQueryParams.A builder for
IAppointmentQueryParams.An implementation of a
IAppointmentRangeView that takes an existing appointment and reflects changes in that
appointment.Bean for the appointment schedule view in the inbox.
Describes an available slot (time range) of an
AppointmentTemplate.API class for reading and writing
AppointmentSlot entities.Implementation of the
IAppointmentSlotDao for reading and writing AppointmentSlot entities.Handler implementation for reading and writing
AppointmentTemplate entities.Converts between a free
IAppointmentFreeSlot returned by the appointment free slot servlet and the
corresponding LocalDateTime.An entity for the appointment module of formcycle.
API class for reading and writing
AppointmentTemplate entities.Bean for the backend menu that lets the user configure the available appointments.
Implementation of the
IAppointmentTemplateDao for reading and writing AppointmentTemplate entities.POJO implementation of
IAppointmentTemplateData.Bean for the backend menu for deleting one or multiple appointment templates.
Handler implementation for reading and writing
AppointmentTemplate entities.Deprecated.
The view model for the
AppointmentTemplate - the backend menu for configuring the appointments.Event for when an entity was modified, either when it was created, updated, or deleted.
Bean for the appointment menu that lets the user change the details of a slot, mainly the start end time.
Describes the type of an appointment and contains several metadata, such as the duration of the appointment.
API class for reading and writing
AppointmentType entities.Implementation of the
IAppointmentDao for reading and writing Appointment entities.Handler implementation for reading and writing
AppointmentType entities.POJO implementation of
IAppointmentValidateParams with a builder.Validation builder for validation a sequence of appointment actions.
Deprecated.
This is part of the old workflow engine.
Abstract bean base class for displaying or editing the details of a single project
Base POJO class implementing the methods of
IProjectProvidingEvent.Exception for failed email archiving.
Base class for servlet parameters classes.
Deprecated.
use
MultipartRequestDeprecated.
Exception die bei fehlender Lizenz geworfen wird
Helper functions related to the Aspose license.
Helper class to convert between Java locales and Aspose locales.
Diese Klasse dient dazu ein Word-Dokument mit Formularinhalten zu befüllen und als PDF (andere, von Aspose
unterstützte Ausgabetypen möglich) anzulegen.
Contains all methods that associate derived quantities with the current state.
Stores quantities derived from the current state.
Base class for beans for a PrimeFaces chart.
A list converter for the
Tagify component.Abstrakte Klasse zur Bereitstellung einer einheitlichen Verarbeitung von Requests an die Handler-Klassen
Die Klasse
Attachment beinhaltet Meta-Informationen zu einem im System verfügbaren Anhang.API class for manipulation of
Attachment entities.Download eines oder mehrerer Attachments eines Vorgangs
Behandlung von Attachments innerhalb des Formulars
The Class AttachmentHandler.
Models the descriptor for an attachment reference that can be selected in the configuration UI of some workflow
actions.
A choice provider for the workflow that finds the available attachment items from the current
bean validation context obtained via CDI.POJO class used when a form with uploads was submitted.
Builder for persisting attachments of a
Vorgang an returning that form record.POJO model for the metadata of a form upload, identified by its UUID.
POJO implementation of
IAttachmentValueDescriptor.Abstract base class for formcycle type adapters for GSON serialization
Abstract base class for faces validators that check whether a certain field of an entity is unique amongst all
existing entities within a certain scope.
AUniqueManDepNameValidator<T extends INameProviding & de.xima.cmn.dao.interfaces.IEntity<Long> & IMandantDependent>
Attach this validator to the input field for the
INameProviding.getName() of an IEntity.Abstract base class for faces validators that check whether a certain string field of an entity is unique amongst all
existing entities within a certain scope.
Endpoint for authentication request callbacks.
Used for polling of new frid during authentication
Helper class for working with the
AuthClientCache.Sets up the
ProjectAuthenticatorConfigs of a project from old entity dataFactory for
IAuthenticationTargets.Adds the authentication target to the authentication attributes of the user profile.
Generator for authentication target values
Bean for testing the client
Builder for
AuthenticatorConfigRenderContextThis model represents the data about dependencies a authenticator could have.
Factory for creating models for accessing the properties (
IAuthenticatorProperties) of authenticator entities
(IAuthenticator).Factory for creating authenticator renderers.
Exception which is thrown when an authentication-error occurs
Helper class for dealing with authentication
Helper class for security logics.
Endpoint for authentication login request.
Builds login URLs for authentication clients.
Handles redirect to logout template
Deprecated.
Authorization is now handled via pac4j.
Properties model for authorization filters of
IndirectClientAuthorizations.Builder for different types of
IAuthorizers.AuthPluginParameterModel<E extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>
Marks old HTML templates as outdated and creates/resets new templates for authentication
Factory for creating
auth web contexts.Deprecated.
Use
ClientFactory or FormClientFactory instead if you want to create pac4j clients.Deprecated.
functionality has been moved to package fc-security.
A
Sardine that can also be closed automatically so that it can be used with a
try-with-resources statement.Deprecated.
Deprecated.
Model for the data needed for auto login which is saved in the browser via a Cookie value.
Factory for creating state resolvers of views.
Helper bean for rendering avatar composite components.
Deprecated.
This is part of the old workflow engine.
AWorkflowElement<TElement extends IWorkflowElementEntity,TSearchTerm extends AWorkflowElementSearchTerm<TElement>>
Base class for workflow elements, i.e. nodes and triggers.
Abstract base class for element categories
Each workflow element can have one or more search terms that are used in database queries to filter the applicable
elements.
Base test for all workflow tests that created the workflow process.
Base POJO class that can be used (but does not have to be) for implementations of
IWorkflowEventData.Stores all the properties (
XPropertyEnum) of a form item and offers methods to access these properties.AzureAdOauth2AuthenticatorProperties<TAuthenticator extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for the properties of an authenticator of type
EAuthClientType.AZURE_AD.Built-in default implementation for a plugin profile filter extensions for authenticators of type
EAuthClientType.AZURE_AD.AzureAdWrapper<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Deprecated.
Use
AzureAdOauth2AuthenticatorProperties instead.A backend push context that should scoped to the application scope.
Initializer class providing the backend authentication logics (login, callback).
Factory for creating Pac4j
Clients.Extension of the
pac4j Clients, that provide the backend authentication clients.Servlet context listener for executing common initialization and shutdown tasks for web applications with access to
the backend (MS and Fs with Inbox).
Bean with the action listener for the
AjaxCallPushData.getActionListener().Keepalive check for the OmniFaces socket, with a mutex scoped to the current application.
Keepalive check for the OmniFaces socket, with a mutex scoped to the current session.
Keepalive check for the OmniFaces socket, with a mutex scoped to the current view.
Producer for the formcycle backend
security config.Filter that adds security-relevant headers and other settings for the backend.
A backend push context that should be scoped to a HTTP session.
A backend push context that is scoped to a JSF view.
Event for the
Flowchart component, when the backup state has unsaved changed.Event for the
Flowchart component, when the presence of a backup was detected on the client.Event for the
Flowchart component, when the backup state has no unsaved changed.Base class for node properties.
Helper methods for the appointment module.
Base class for common properties used by binary condition nodes.
View model for general authenticator configs
Base designer model used by all designer pages.
Base class for all cluster events with a node.
A base implementation of
IResolvedFileListProcessor that ignores all errors.Base class for events the relate to a change in the cluster topology (e.g. when a node was added or removed).
Base class for trigger properties.
Model class for a basic client authorization.
Basisklasse für
ProjectDataTableBean und ProjectInboxBeanModel class for basic form record request data
Extends the
DefaultScheduleModel and adds some additional functionality.API class for manipulation of beans.
Adapter for
CDI BeanManager which extends default BeanManger functionalityHilfsklasse für das (generische) Setzen von Eigenschaften (speziell von Entitäten).
AN implementation of
IWorkflowValidationEnvironmentData that lazily reads the data from the context beans
(session bean, locale bean etc.).Deprecated.
This entity is part of the old workflow engine.
Deprecated.
Use
WorkflowNodeAPI and the new workflow engine.Deprecated.
Deprecated.
This is part of the old rest API.
Deprecated.
Since Version 8.0.0 user information is stored in
user profiles.Deprecated.
The
Benutzer has been replaced by UserProfile.Deprecated.
Since Version 8.0.0 user information is stored
UserProfiles.Diese Entität bildet ein Guppensystem ab, dem verschiedene
Benutzer zugeordnet werden können.API class for manipulation of
BenutzerGruppe entities.The Class BenutzerHandler.
Deprecated.
The
Benutzer has been replaced by UserProfile.Deprecated.
This is part of the old rest API.
Binary data that can be added to a HTTP request.
Class for storing informations and data for an mail-bodypart based on text
Helper bean for rendering the
<xi:breadCrumb /> composite component.Resolves protocol entries for DAO bulk operations on entities.
Implements
IResourceDescriptor via data from a byte array.Utility class for working with byte order marks.
Bean zum Abspeichern / Laden der NTLM-Konfiguration.
Deprecated.
will be removed
Deprecated.
will be removed
HTTP action adapter for authentication request callbacks.
A class loader that combines several other class loaders.
Modelklasse für den Login
Models the state of a cluster channel for a node in the cluster.
A message sent to the client via a web socket.
This filter will set the request body character encoding.
Entity model for user authenticators in
Mandant scopeThe default implementation of
IClientAuthenticatorDao that can be accessed via DaoProvider.Handler implementation for reading and writing
ClientAuthenticator entities.Bean for handling of
IEntityClientAuthorization in the authorizations.xhtmlBean extending
ClientAuthorizationBean for handling of dialog validate()Helper class for working with
IClientAuthorizationsHelper bean for working with
IEntityClientAuthorizations.Bean for displaying the result of a client authorization test by user login.
View of a
ClientCounter that can be sent to the client.View of a
ClientResource that can be sent to the client.Marker-Annotation für Konstanten, die sowohl server- wie auch clientseitig verwendet werden.
Counter entity in
Mandant scopeAPI for
ClientCounters that can be accessed via APIProvider.Provider for client counters available in the current client during workflow editing and validation.
Bean for configuring
ClientCounter entitiesThe default implementation of
IClientCounterDao that can be accessed via DaoProvider.Listener registrator for listeners of the
ClientCounterDaoDefault implementation of
IClientCounterHandlerImport config for
ClientCountersEvent for when an entity was modified, either when it was created, updated, or deleted.
Job for periodically resetting a counter
Servlet for accessing
ClientCountersBuilder for client dashboard panel entries.
Runnable for deleting all quartz jobs/triggers of the given workflow trigger type and deleted client.
Factory creating client descriptors for authentication/security.
Helper for retrieving client descriptors for a context.
View of a
direct client authorization that can be sent to the client.Factory for creating Pac4j
Clients.Entity representing files of a
MandantEntity containing the actual data of a user profile file entity
Deprecated.
Use
ClientFormTrackerHelper instead.Bean for the flowchart component to locate the appropriate client handlers.
Similar to
IGuiIcon, but a final mutable class that can be serialized and deserialized via JSON.Wraps a
ClientIcon and treats it as a IGuiIcon.View of an
Inbox that can be sent to the client.Represents an opaque (=no transparency) color for a node or trigger.
Diese Klasse dient dazu eine
PaginationCriterion-Instanz aus HttpServletRequest-Parametern zu
erzeugen.Entity for the binary data of an client-wide plugin
Entity for the configuration of an client-wide plugin
Entity for the binary data of an client-wide plugin
Entity for the binary data of an system-wide plugin
View of a
ProjectResource that can be sent to the client.Deprecated.
Deprecated.
This class is part of the old workflow engine and will be removed together with it soon.
Event for when an entity was modified, either when it was created, updated, or deleted.
View of a
IWorkflowSubmitButton that can be sent to the client.View of a
Textbaustein that can be sent to the client.View of a
UserGroup that can be sent to the client.Deprecated.
Utility class for working with
clients.View of a
WorkflowState that can be sent to the client.A
auto closable wrapper for an item that needs to be cleaned up via a custom close action.Default implementation of a
IClusterChannelStateObserver that delegates to the registered
IClusterChannelStateListener.A message is sent to control other nodes, such as when a node should change its state and start or stop performing
work.
Manager for the cluster that can be used to control the cluster in a way that is independent of the implementation
used for the clustering.
Default implementation of
IClusterMessageObserver that delegates to the registered
IClusterMessageListener.Exception that is thrown when a cluster connection could not be opened.
A message that is sent when a plugin was activated or deactivated.
Default implementation of
IClusterTopologyObserver that delegates to the registered
IClusterTopologyListener.Allgemeine Konstanten.
Parameters for the AJAX upload servlet (/form/ajaxupload).
Parameters for the addUpload sub request type of the AJAX upload servlet.
Parameters for the appointment free slots servlet (/appointment/freeslots).
Parameters for the appointment iCal servlet (/appointment/ical)
Keys, that used with the
MDC The Keys can be used inside a log file pattern configuration with the
placeholder '%X{<key>}'.Result for the server side linting callback of code mirror, see the script function
Formcycle.CodeMirror.setupLintingImplementation of
IStandardAttachmentListResolutionErrorCreator that lets you customize only the error code
for each error type, and provides no error data.Builder to build
CodeOnlyStandardAttachmentListResolutionErrorCreator.Implementation of
IStandardFileListResolutionErrorCreator that lets you customize only the error code for
each error type, and provides no error data.Builder to build
CodeOnlyStandardFileListResolutionErrorCreator.We use the monaco editor for editing JavaScript.
List of common
IColorFields.Constants with the
IColorField.getIdentifier() values for the ColorFields.Implements
IResourceDescriptor by combining several IResourceDescriptor.Initializer class for common authentication logics (login, callback).
A Hibernate bean validation API resource bundle locator for the
xima-common-localizations resource bundle.A JAKARTA bean validation API message interpolator for the
xima-common-localizations resource bundle.Helper for setting up interfaces to the
fc-common module allowing access to other modules.List of common, non-dynamic placeholders that can be used within formcycle.
List of common, non-dynamic
session placeholders that can be used within
formcycle.List of common, non-dynamic
form placeholders that can be used within formcycle.List of common, non-dynamic
system placeholders that can be used within
formcycle.CommonRedirectAuthenticatorProperties<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for the properties of authenticators that use redirection to an external IDP.
Common helper for maintaining compatibility.
Utility methods for working with
UIComponents.Predicate that combines multiple single conditions via a
EMultipleConditionCombinationType.An upload that replaces the original image with a compressed and/or scaled down version.
Deprecated.
Use the new workflow engine (
CompoundConditionEvaluator).Helper class providing generic condition check utility methods.
Factory for creating
IAuthenticatorConfigWrapperFilter for all pages that require access to the database.
Deprecated.
This is part of the old workflow engine.
Class for working with the
Content-Disposition.Exception thrown by
ContentDisposition when a value cannot be parsed.An HTTP request parameter with a name, value, and content type that can be added to a request.
Performs content type detection by utilizing the Apache Tika framework.
URL resolver that prepends the context part to the URL if missing.
An implementation of
IPlaceholderType for context placeholders of the form [%key.value%].An entity context intended to be used when you do not know whether you are inside a UI thread or not.
Can be used together with a <xi:convertible> component.
Indicates that a form record could not be locked
A generic AJAX behavior event that is triggered when an item was inserted somewhere.
System update that creates all
IndirectClientAuthorizations.System update that creates all necessary LDAP authenticators
Exceptions for expired credentials on a user profile.
POJO push data for the cross view scope request.
POJO model for the data received from the client to a cross view scope push message.
POJO push data for the cross view scope request.
Static factory methods for different CSS syntax types.
Represents an analyzed CSS class.
A CSS color value, with optional transparency.
Simple builder for creating a CSS
declaration list string (e.g. a list of styles such as
color: red; background: green;
For lengths,you can use strings or numbers (uses the default unit ECssUnit.PIXELS.Constants with the pre-defined default values
any CSS property accepts.
Represents the font faces contained in an analyzed CSS file.
A CSS file to include in the designer.
Represents an analyzed CSS file.
Client-side model for requesting info about a CSS file.
Simple builder for creating a CSS rule list
string, e.g.
Simple builder for creating CSS selector string, e.g.
Simple builder for creating a CSS transform
list string, e.g.
Helper for replacing URLs in CSS files.
Wrapper class for CSV formats
Utility class for importing CSV files
Wrapper class for CSV parser
Wrapper class for CSV printer
Wrapper class for CSV records
Deprecated.
Replaced by
ProjectPageBean.Simple POJO implementation of an
AjaxSource with setters for programmatic configuration.Model with the additional data for the JSON serialized form of a workflow version (in addition to the process model).
A custom
IGuiColor color with a builder that supports whatever color fields were added during the build
process.Simple builder for a
CustomColor.A custom GUI icon with a freely configurable style, style class, and value.
A new builder for a custom GUI icon.
Resource for custom content
Deprecated.
Use
PluginMenuEntryView instead.Parts of the
WorkflowExternalState that is sent to the client.Mixin to simplify CRUD (create-read-update-delete) operations on entities implemented via the
DaoProvider
layer .LazyDataModel for IEntitys & use with DataTable.Keeps a static reference to all DAO (data access object) instances.
Implementation of
IAppointmentIcalQueryAccessObject that uses the DaoProviders.Implementation of
IAppointmentValidationAccessObject that uses the DaoProvider.APPOINTMENT_DAO.View scoped bean holding the dashboard of the backend.
CDI-injectable provider for the database connections available in the current client during workflow editing and
validation.
Event for when an entity was modified, either when it was created, updated, or deleted.
A
health check that checks whether the connection to the system database is valid.Deprecated.
use
DatabaseMonitorCDI-injectable provider for the URL templates available during workflow editing and validation.
Deprecated.
use
DatabaseUtilsDeprecated.
Event for when an entity was modified, either when it was created, updated, or deleted.
Bean für die aktuelle Session und deren Informationen
Bean for handling data source manipulation through excel-like sheet
Simple Model holding headers and data rows of a fixed data table for outputting information
Generic model for markable & selectable data table entries.
Datenabfrage-DB-Servlet
Datenabfrage-LDAP-Servlet
API class for manipulation of
DatenbankZugriff entities.The default implementation of
IDatenbankZugriffDao that can be accessed via DaoProvider.API class for manipulation of
Datenquelle entities.The Class DataStoreHandler.
DatenquelleXMLServlet
Bean für die Verwaltung von Verbindungen
Deprecated.
use
UpdateBean.getDbEncryption() insteadBean for handling db queries
Deprecated.
use
UpdateBean.getDbSettings() insteadSystem update that deactivates the NTLM configuration if it is active.
Default implementation for accessing the clients of an authenticator depending on the authentication flow.
Default-implementation for creating clients
Default-implementation of the default data to use while creating an client
Default
context value replacer implementation provided by formcycle that is always
available.Default implementation of
IConvertibleMap that just uses a HashMap.Enumeration of
TemporalQuerys for a ZonedDateTime that defaults to a certain value when a
TemporalField is missing in the TemporalAccessor.Default writer for entities that serializes the entity based on
ExportDetailsCreates the default serializer and deserializer configurations for fast JSON.
Default implementation of
IFastJsonConverter that does not add any custom serializers etc.Implementation of the
IFD2AppointmentProvider.Helper for creating a
XItemConditionsWrapper based on the data of a form record.Deprecated.
Diese Klasse kapselt ein
Script-Objekt welches als Node im einem HTML-Generierungsprozess eingebunden
werden kann.Default implementation of
IFD2RenderCallbackProvider that handles plugin render callbacks.Default provider for
Textbaustein dataDefault POJO implementation for
IPluginFormElementTemplateList.Simple builder for a
IPluginFormElementTemplateList.Default implementations for
IPluginFormElementTemplateLoader.Default
form value replacer implementation provided by formcycle that is always
available.Default
form value replacer implementation provided by formcycle thati is always
available.Default identity check handler that executes a Java method if the tokens match.
Default converter for the tagify component.
Default implementation for sending mails via smtp
Deprecated.
Deprecated.
Default POJO implementation of
IExtendedParameterModel.Default POJO implementation of
IPluginFormElementCatalogParams.Default implementation for
IPluginFormElementTemplateDescriptor with a simple builder.Simple builder for a
IPluginFormElementTemplateDescriptor.Default POJO implementation of
IPluginFormElementTemplateIcon.Default implementation of a plugin profile attribute filter attribute.
Default implementation of a plugin profile attribute value.
Default POJO implementation of
IPluginValidationData.Default POJO implementation of
IPluginInitializeValidationResult.Default
session value replacer implementation provided by formcycle that is always
available.Contains the default implementation for the
addNewListener and deleteListener required by the
settings.xhtml custom component.Default
system value replacer implementation provided by formcycle that is always
available.Default
template value replacer implementation provided by formcycle that is always
available.Default implementation of
IAuthenticatorConfigRenderer for authenticators that use an input mask with
username & password fields.Default (mainly POJO) implementation of the
IWorkflowLocalHandlerValidationContext and
IWorkflowGlobalHandlerValidationContext.The default
field name conventions suitable for most form items that consist of
only a single input, select, or textarea field in the rendered form, with a name as configured in the form designer.Model representing a reason for the deletion of one or more entities.
AStringListConverter that simply splits the string by the given delimiters.Deprecates the
Textbaustein of type ETextbausteinMsgCode.SYSTEM_INFORMATION.Deprecated.
IEntityDeserializationResult is now used for entity deserializationr resultsController bean for adding a new workflow state to the workflow.
Utility methods for creating the designer JSON config required by the client side JavaScript.
View handler for the designer that adds the designer conversation ID to all URLs.
Bean for handling the designer conversation context.
Info about the current client and project opened in the designer.
POJO model for the current global state of a designer instance.
Helper methods for working with and modifying the
DesignerConversationModel.Handles designer conversation events that are relevant to the designer frame.
Bean for the new designer.
Utility methods for creating the various models used by the designer frame.
Bean for all designer pages.
Model for preferences of a
UserProfile regarding the Designer.Controller for the form preview XHTML page.
Utility methods for responding to invalid requests when the designer is opened.
Called during pre-render view and creates the designer model.
Helper for adding new state to the workflow.
Bean controlling the components of the designer.
Servlet context listener that checks whether
javax.faces.PROJECT_STAGE) is set to
ProjectStage.Development.A resource meant only for development.
Filer that is added dynamically when dev mode is activated.
Deprecated.
Wraps a resource and serves it directly from the file system when dev mode is turned on.
Emulates the dynamic functionality of a primefaces dialog.
Direct client authorizations define the permissions of
UserProfiles to Mandants via Rolles
and BenutzerGruppes.API class for reading and writing
DirectClientAuthorization entities.Provider for the direct client authorizations available in the current client during workflow editing and validation.
Implementation of the
IDirectClientAuthorizationDao for reading and writing DirectClientAuthorization
entities.Handler implementation for reading and writing
DirectClientAuthorization entities.Event for when an entity was modified, either when it was created, updated, or deleted.
This factory creates general
direct clients for IAuthenticators with sensible defaults that
can be used in various contexts.Default POJO implementation of a
IDiscriminatedUnionMember.Authentication config wrapper for a distinct user.
Holds a map with frequently used suffixes of files as keys and grouping them through the values, each value has a
visual representation for p:treeNode
Model class for the result of the execution of a double opt-in verification event.
Deprecated.
Do not use these utility methods.
Postfach-Dialog...
Parameters for the local backup download, see
FormBackupHelper and
FormDesignerBackupBean.getLocalBackup().Model that stores the available prototypes for the workflow elements.
Factory for creating dummy
authenticator properties for use by pac4j clients.Builder for creating (mock)
pac4j profiles.Exception thrown when a multiple form elements have got the same alias, such as when persisting a form version.
A
IComponentValueConverter for splitting a Duration field into its components.An access property describes the permissions a formcycle user is granted.
Categories of the admin dashboard, used by IMenuEntryModel.
Resultat eines Workflow-Schrittes.
The form of address of a person.
Deprecated.
Enum with the available log appender-types
An enumeration of the actions that can be applied to a submitted appointment.
An enumeration of the possible errors that may occur when booking an appointment.
Enumeration with flags for changing the validation process of an
Appointment.An enumeration with the possible errors that may occur when creating an iCal file with the existing
Appointments of an AppointmentTemplate.Indicates the status of an
Appointment.Enumeration of the different error types that can occur when resolving the attachments referenced by a
AttachmentItem.Enumeration of the different types of attachments that can be selected in the configuration of workflow actions.
Types of callback URLs.
An enumeration with the possible states of an authenticator, indicating whether it's configuration is complete.
Enum representing the supported authentication flows for authenticator clients.
Rendering type of the authenticator.
Enum with available authentication-error-reasons
Default authorization filter types.
Default built-in views for business action nodes for the workflow flowchart.
Die Enumeration Benamungsmodus wird dazuverwendet um anzugeben ob die Standardelementbenamung aus dem Designer
genutzt wird, oder die benutzerspezifischen Benamungen.
Der Benutzerstatus gibt an ob der Nutzer das System nutzen kann, er blockiert oder gar gelöscht ist.
Deprecated.
User profiles can have multiple user identities.
Deprecated.
Use
SystemAuthenticators for the backend instead.The
IXItemFieldNameConventions for the builtin items (that have special conventions).Enumeration of possible byte order marks, indicating whether a byte order mark is added to some data.
Enumeration of the different ways to change a form's availability, used by the workflow action.
View definitions that require an authenticated in user and depend on a client.
Enumeration of the possible control commands that can be sent to a node in the cluster.
Enumeration of the possible implementations for the cluster.
Enumeration of available color palettes for the web.
Representing label options for columns during form record export
Common implementations of
IAttachmentSearchOptions.Common implementations of
IFileSearchOptions.Enumeration with the possible values for how files are named when put into a ZIP archive.
Enum der Verbindungs-Status
Enumeration describing views to formcycle content pages.
Defines types of actions for counters.
Enum representing different groups for referencing counters
Types of conditions by which an object/entity may be reset
Constants with the pre-defined values for the CSS property
align-items.Constants with the pre-defined values for the CSS property
background-repeat.Constants with the pre-defined values for the CSS property
box-sizing.Constants with the pre-defined values for the CSS property
cursor.Constants with the pre-defined values for the CSS property
display.Constants with the pre-defined values for the CSS property
justify-content.Constants with the pre-defined values for the CSS property
overflow.Constants with the pre-defined values for the CSS property
pointer-events.Constants with the pre-defined values for the CSS property
position.Enumeration of the possible CSS request types, see
CssRequest.Constants with the pre-defined values for the CSS property
text-align.Constants with the pre-defined values for the CSS property
transform-origin.Enumeration of CSS units.
Enum of CSV import optionsEnum for different view types for inputing or presenting information.
Enumeration of the database management systems natively supported by formcycle.
Deprecated.
Not needed anymore.
Default definitions for designer web endpoints.
Deprecated.
Enumeration of how the content of a designer tab is rendered.
Enumeration of the cross view upload file sources used in the designer.
Enumeration of how how a workflow element can provide the user with a usage help page.
Enumeration of tags for workflow element prototypes that affect how the prototypes are displayed etc.
Enumeration of the possible types how a workflow element prototype is displayed in the drawer and overlay panels.
Format of mail as file for archive.
Types of mail body sending format
Possible actions if entity conflicts arise
Describes how to find the key for entity list views to store the currently selected entity via the
SelectionBean.Type of reference to an entity
Beschreibt die verschieden Typen von Fehlern die auftreten können.
Deprecated.
Use the new workflow engine, such as
WorkflowNode and WorkflowTrigger.Context for use in
ExportDetails to determine when a field should be exportedEnumeration of additional fields that can be included in the generated XML file with the submitted form data.
Serializable wrapper for a
FacesMessage FacesMessage.Severity.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_CHANGE_FORM_AVAILABILITY action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_CHANGE_FORM_AVAILABILITY action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_CHANGE_FORM_VALUE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_CHANGE_FORM_VALUE action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_CHANGE_STATE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_CHANGE_STATE action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_COMPRESS_AS_ZIP action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_COMPRESS_AS_ZIP action.Enumeration with the updates for the properties of the compress as ZIP action.
Enumeration of the possible error codes for the
EWorkflowNodeType.FC_COPY_FORM_RECORD action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_COPY_FORM_RECORD action.Enumeration of possible error codes for the
EWorkflowNodeType.FC_COUNTER actions.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_COUNTER action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_CREATE_TEXT_FILE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_CREATE_TEXT_FILE action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_DECODE_BASE64 action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_DECODE_BASE64 action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_DELETE_ATTACHMENT action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_DELETE_ATTACHMENT action.Enumeration of possible error codes for the
EWorkflowNodeType.FC_DOI_INIT action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_DOI_INIT action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_EMAIL action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_EMAIL action.Enumeration with the updates for the properties of the email workflow action.
Enumeration of the possible error codes for the
EWorkflowNodeType.FC_ENCODE_BASE64 action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_ENCODE_BASE64 action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_EXPERIMENT action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_EXPERIMENT action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_EXPORT_TO_PERSISTENCE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_EXPORT_TO_PERSISTENCE action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_EXPORT_TO_XML action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_EXPORT_TO_XML action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_FILL_PDF action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_FILL_PDF action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_FILL_WORD action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_FILL_WORD action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_POST_REQUEST action.Updates for the
FcHttpRequestProps model class.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_POST_REQUEST action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XML action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XML action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_LDAP_QUERY action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_LDAP_QUERY action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_LOG_ENTRY action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_LOG_ENTRY action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOX action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOX action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_MULTIPLE_CONDITION action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_MULTIPLE_CONDITION action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_PROCESS_LOG_PDF action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_PROCESS_LOG_PDF action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_PROVIDE_RESOURCE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_PROVIDE_RESOURCE action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_CHANGE_STATE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_QUEUE_TASK action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_THROW_EXCEPTION action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_REDIRECT action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_RENEW_PROCESS_ID action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_RENEW_PROCESS_ID action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_RETURN_FILE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_RETURN_FILE action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEM action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEM action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SAVE_TO_WEB_DAVEnumeration of the possible soft error codes for the
EWorkflowNodeType.FC_SAVE_TO_WEB_DAVTypes of formcycle servers.
Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SET_SAVED_FLAG action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_SET_SAVED_FLAG action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SHOW_TEMPLATE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_SHOW_TEMPLATE action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SQL_STATEMENT action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_SQL_STATEMENT action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SWITCH action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SWITCH action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_THROW_EXCEPTION action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_THROW_EXCEPTION action.Default formcycle web app features.
Enumeration of the possible error codes for the
EWorkflowNodeType.FC_WRITE_FORM_RECORD_ATTRIBUTES action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_WRITE_FORM_RECORD_ATTRIBUTES
action.Enumeration indicating how to proceed when a file exists already.
Enumeration with the possible actions to be taken when an uploaded file conflicts with an existing file.
Enumeration of the possible request source that may trigger a backup detect event.
Deprecated.
Elementtypen in Formularen, die für die Platzhalter-API relevant sind.
Type of form print export
Enumeration indicating which part of a form should be exported.
This enum lists the different types of form elements.
Definiert die möglichen Import/Export-Optionen für ein Formular
Enumeration with the possible behaviors how a form record is treated when the associated form is currently offline.
Enumeration of the different form persist files.
Export format for printing forms
Deprecated.
Only used by old form record, use the new workflow engine
Enum for regulating access to form records
Enum for displaying different kinds of quartz jobs for form records.
FormVersion-Komandos
Denotes the type of output that is being generated by
EFormShareTypesEnum representing ways of sharing formcycle forms along with customization options
When a form is submitted, a new state must be determined for the form.
Von Formcycle unterstützte Formulartypen.
FormVersion aktionen einer FormVersion
Freigabe-Status einer FormVersion
Typ des Freigabemechanismus eines Mandanten
Enum representing hash algorithms.
Pre-defined HttpClients for executing HTTP requests.
Enumeration of the possible content types that can be selected for the
EWorkflowNodeType#FC_POST_REQUEST.How to handle redirect (relative) URIs when sending an HTTP request and the response has a 3xx status code with a
Location header.Enumeration for the various ways of configuring the body of an HTTP request, used by the HTTP request workflow
action.
A list of well-known HTTP verbs, mostly those defined by the HTTP/1.0 and HTTP/1.1 standards.
Given a default string and a language-specific string, indicates which string should be used.
Error reasons why the one-time submission token check failed.
Default definitions for inbox web endpoints.
Default definitions for includes web endpoints.
Enum representing the layout options of credentials authenticators (i.e.
Types of priorities for internal messages which indicates the importance of treating a message.
Enumeration of the different internal message types which accessable in different scopes.
Enumeration for the different actions that can be applied to timed jobs.
Enum representing the options for defining an LDAP user filter for KERBEROS authentications.
Supported default languages for the formcycle backend.
Enum with appender-layout patterns
Controller for the drawer panel and the task / node add panel.
Default POJO implementation of
IElementGlobalValidationParams.POJO implementation of
IElementHelpLocation with some additional static factory methods for convenience.Beans which handles the element info dialog for a flowchart node or trigger.
View Model storing the data that shown in the element info dialog of the flowchart.
Event for the
Flowchart component, when more info regarding an element was requested (by clicking on the info
button).Default POJO implementation of
IElementPropInitParams.The key of a workflow element that uniquely identifies it within the context of a process.
Default POJO implementation of
IElementLocalValidationParams.Represents a message that is shown for a certain
NodeModel or TriggerModel.Represents the set of (usually validation) messages for a
NodeModel or TriggerModel.Helper methods for creating and modifying a
ElementInfoPanelModel for nodes.Bean for the properties panel to the right, that may contain node or trigger properties.
Static methods for the
NodePropertiesBean and TriggerPropertiesBean.Default POJO implementation of
IElementPrototypeDescriptor.ElementPrototypeDescriptor.ElementPrototypeBuilder<TSelf,TData,TPayload extends IElementPrototypeData<TData>>
Simple builder for configuring an element prototype.
JSON-convertible client model that represents a prototype for a flowchart element that corresponds to a HTML element.
Static function for creating workflow element prototypes.
Default implementation of a
IWorkflowElementValidationResultBuilder.Helper methods for creating and modifying a
ElementInfoPanelModel for triggers.Default POJO implementation of
IElementUpdateCurrentPropsParams.POJO implementation of
IElementUpdateCurrentTaskParams.POJO implementation of
IElementWithTask.Enumeration of the available license type.
Deprecated.
use
ELiquibaseCmdDeprecated.
Enumeration on the different levels of workflow actions which are relevant for a log filter.
Deprecated.
Deprecated.
Possible positions for the login notice on the login screen.
Enum representing the state of user credentials logins.
Enum representing log levels
Deprecated.
Enumeration of possible authentication methods.
Enumeration of possible email encryption methods.
When sending mails, whether the sender address can be changed.
The scope of a
IMailServerData, indicating in which scope the mail server was configured.Enumerates the possible outcomes of a malware scan.
Enumeration of default options for the monaco code editor.
An event execution result that can be used when no tasks were executed, such as when no triggers fired).
An implementation of
IResourceDescriptor that represents an empty resource (empty string).Color palette from https://github.com/mrmrs/colors.
Enum of types of MFA tokens.
Enumeration of the possible ways to handle Unicode characters in headers of multipart HTTP requests.
Enumeration of the different possibilities how the individual conditions of a multiple condition workflow node may be
combined.
A
Collector for
IResolvedAttachmentList#collectResult that returns the files of all resource items.A
Collector for
IResolvedFileList#collectResult that returns the files of all resource items.Color palette from chartjs-plugin-colorschemes.
Enumeration of CSS color name, together with the usual color values.
Generates new HTML templates for authentication
POJO class describing an end point of a range, either a lower or upper end point.
Interface for a handler that allows accessing a
Range endpoint of some object.An enumeration containing instances of
EndpointAccessor, for Range.lowerEndpoint()s or
Range.upperEndpoint().An enumeration with implementations of
EndpointAccessors for accessing the end points of Range
objects.Interface for a handler that describes the properties of an end point of
Range.An enumeration with implementations of
EndpointDescriptors.Describes the direction or type of end point, i.e. whether it is a lower or upper end point.
Interface for a handler that describes an end of an interval.
A comparator for comparing two end points of a range.
An enumeration with implementations of
EndpointTypeComparator.An enumeration with implementations of all possible
EndpointTypes.Enumeration of the possible types how the execution of a workflow node was completed.
Enumeration describing the possible states of a node in the cluster.
Enumeration of the possible modes of a node, i.e. which role a node represents in the cluster.
Deprecated.
Use the new workflow engine.
A class that encapsulates a running
IPluginEntities.A global manager for the
EntitiesRuntimes instances.Helper class for providing alternatives during entity import
Authenticator for retrieving
UserProfiles by validating username password credentials against an entity
authenticator given by UUID over the API.Deprecated.
Entity does not exist anymore.
Comparator for
IEntitysWrapper for authenticator configs that use an
IAuthenticator entityModel for describing a formcycle entities
Factory for formcycle entity exporters
Factory for creating the export files for entities during serialization
Helper class for generating
StreamedContent from entitiesPOJO view for the
AttributeSelectCriteriaManager when selecting only the ID of an entity.Deprecated.
Annotation for customizing the deserialization process during entity import to take into account deprecated fields
Deprecated.
Use specialised importers like the
ProjectImporter insteadHelper class for importing entities
Model class for entity import results
Deprecated.
Extends the
EntityListModel and adds functionality for memorizing the currently selected entity for the
duration of the current session.Model class for referencing an entity either by
UUID or nameEntityReferenceDaoListener<TReferenced extends de.xima.cmn.dao.interfaces.IEntity<Long>,TReferencing extends de.xima.cmn.dao.interfaces.IEntity<Long>>
A
IDaoActionListener for checking whether an entity is still referenced by another entity, and preventing the
deletion of said entity if it is.POJO implementation of
IEntityReferenceDescriptor.Class for (de-)serializing entities
Deprecated.
Use
DefaultEntityReader or DefaultEntityWriter instead.Behandelt Einschränkungen bezüglich Enums, welche bei bestimmten Entitäten unterschiedliche Werte annehmen kann.
Deprecated.
This is part of the old rest API.
Transformer similar to for enums which allows you to specify how unknown enum constants are handled.Result returned by
IObjectGraphVisitor that indicates how the visit should proceed.Enum representing parts of a formcycle page, such as e.g. a dialog on a page.
Typen für die Art der Passwortvergabe (bei Anlegen eines Benutzers)
Link-Typen für das Passwort am Benutzer setzen
Enum representing the state of resetting a user password.
Enumeration of JSON patch operation.
Enumeration with the different types of AcroForm fields.
Enumeration of several common
IPlaceholderEscaper implementations.Enumeration of the different placeholder types that can be distinguished solely by their string representation,
without semantic information from placeholder replacement handlers.
Common placeholder types.
Deprecated.
An enumeration of the different types of plugin related events for which a listener may be registered.
This enum is for checking the overwritability of a plugin when updating manually via the plugin interface.
Enumeration with the status of a placeholder replacement plugin.
Deprecated.
Enumeration of server types on which the installation of a plugin should be limited.
Enumeration of the possible scope of a plugin store item, indicating also if the client overloads a plugin installed
also in system scope.
Enumeration of the possible status of a plugin store item, indicating whether the plugin is installable or already
installed.
Deprecated.
use the Sub-Interfaces of
IFCPluginEnumeration of the plugin update availability status which is determined through proma.
The possible outcomes of a plugin update.
How to proceed when installing a plugin and the plugin fails to validate.
Enumeration for the types of data provided by the workflow.
Options during project import for choosing how the project access will be resolved
Deprecated.
Since formcycle version 7.0.0 projects can only be exported with the new export format.
Enumeration of how the an imported export file is used.
Definiert die projektspezifischen Datentabelle, in denen die Vorgangsdaten abgelegt werden können.
View definitions that require an authenticated user and depend on a project.
Protected view definitions that require an authenticated user
Ranges that may be selected for configuring a protocol cleanup job
That type of protocol that is needed for deleting protocol entries
Deprecated.
Public view definitions that don't require an authenticated in user.
Colors from https://quasar.dev/style/color-palette.
Enum of reserved user reference IDs.
Enumeration of the different error types that can occur when resolving the files references by a
ResourceItem.Enumeration of the different types of resources that can be selected in the configuration of workflow actions.
An enumeration of possible HTTP response types.
Possible values for the
X-Robots-Tag header.Der Enum RollenTyp wird dazu genutzt spezielle Systemberechtigungen zu setzen, die in der Logik selbst ausgewertet
werden und nicht in den
Entityberechtigungen.Bean providing functionality for error pages
POJO model for the error section detailing an error that may be thrown by a node.
The allowed same-site cookie attribute values.
Enum specifying the type of the SAML entity ID.
An enumeration of the available HTTP methods for a HTTP servlet.
A
Collector for
IResolvedAttachmentList#collectResult that returns the first resolved attachment, if any.A
Collector for
IResolvedFileList#collectResult that returns the first resolved file, if any.Type of reference to a state
Deprecated.
Use the new workflow engine, e.g.
Enumeration of how to string are compared to another.
Enum representing the state a
UserCredentials may be in.Enum representing types of system informationView definitions that require an authenticated in user with system role.
Utility for working with the ETag HTTP caching mechanism.
POJO models for an ETag that can be exchanged via HTTP requests for cache control etc.
Type of a form element template shown in the designer.
Dieser Enum listet alle möglichen Nachrichtencodes auf, die Textbausteinen zugeordnet werden können
Enumeration of the possible content types that can be selected for the
EWorkflowNodeType#FC_CREATE_TEXT_FILE.Enumeration with the possible flags for different text formatting styles.
Enumeration of the available duration units the user can enter for
EWorkflowTriggerType.FC_TIME_POINT.Enumeration of the available operations for the left and right hand side expressions the user can enter for
EWorkflowTriggerType.FC_TIME_POINT.Enumeration of the possible ways how a point in time may be specified.
Enum für die möglichen Anzeige-Zeitspannen
Enumeration for the unit of the read and connect timeout of the HTTP request action.
Enum for possible intents of an database transaction.
Deprecated.
Enum representing the roles of a
UserProfile on a system level.Describes the severity of a
IWorkflowValidationMessage.Enumeration of different value types for a JSON like data structure.
API for sending events from FS to MS.
POJO implementation of
IEventExecutionResult.Event handler responsible for delegating events posted over the API.
Helper for locating the workflow tasks that apply to a certain event.
Klasse zum Mappen von hinterlegten Verarbeitungsnamen zur entsprechenden Klasse
Deprecated.
User
IView insteadColor palette with the named colors as defined by the CSS standard.
Deprecated.
Use the new workflow engine, such as
WorkflowNode and WorkflowTrigger.Deprecated.
Enum for wizard steps during CSV importEnum for wizards steps during form link creationEnumeration of built-in categories for workflow nodes and triggers.
A list of built-in workflow types.
Enumeration of
WorkflowStates types that may be treated specially by the system.A list of built-in event names, as required by
AWorkflowElement.getType()Enumeration of the possible validation modes for the
WorkflowValidator.Utility class for importing Excel files
Model class for the result of form record lock requests
POJO data model for the push event beans.
Indicates that execution of a workflow node was aborted.
Enum for the different types of configuration files used by formcycle.
Deprecated.
Deprecated.
Metadaten zum Export
Deprecated.
Deprecated.
Utility class for unzipping formcycle export files
POJO helper class for the appointment free slot query result builder.
Extension of the default pac4j
FormClient with the option of handling invalid credentials on AJAX
authentication request with a custom IInvalidCredentialsHandler.Context of an form-resist-request extended with
HttpServletRequest and HttpServletResponseContext of an form-process-request extended with
HttpServletRequest and HttpServletResponseContext of an form-publish-request extended with
HttpServletRequest and HttpServletResponseContext of an form-render-request extended with
HttpServletRequest and HttpServletResponseContext of an form-request extended with
HttpServletRequest and HttpServletResponseExtended JEE HTTP action adapter that adapts actions with location and content and redirects to default pages if no
content or location was given.
Extension of the default pac4j SAML 2 Authn response validator.
Deprecated.
Use
ExtendedSAML2AuthnResponseValidator instead.Extension of the default pac4j SAML 2 client.
Deprecated.
Use
ExtendedSAML2Client instead.Extension of the default
SAML2IdentityProviderMetadataResolver to include additional caching of URL metadata
resource.Helper class to verify a file's extension against its content.
Processes the extension check (i.e. the verification of a file's extension against its content) and reports the
results.
Simple bean for holding information about extension check results.
Model for (regularly updated) extension check related values that are based on system properties.
Deprecated.
Servlet Filter implementation class ExternalFilter
Bean for the external page
/external/forms.Deprecated.
This class is part of the old workflow engine and will be removed together with it soon.
Default POJO implementation of
IExtractSearchTermsParams.Der Enum Zugriffsrechte dient dazu die Rechte eindeutig zu identifizieren
FacebookAuthenticatorProperties<TAuthenticator extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for accessing the properties of an authenticator of type
EAuthClientType.FACEBOOK in a structured
manner.FacebookWrapper<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Deprecated.
Use
FacebookAuthenticatorProperties instead.Custom
pac4j matcher that checks if the request is a JSF AJAX requests and may reject those.Static methods that can be used within XHTML pages, e.g.
POJO data model for the push event beans.
Context for the workflow validation that is available when bean validation is invoked from JSF.
Fallback execution analyzer when no logic handler could be found for a node.
Similar to
JSONException, but with the difference that this is a checked exception.A
JsonProvider for JSON.A JAKARTA bean validation API message interpolator for formcycle that combines different built-in resource bundles as
well as resource bundles provided by plugins.
The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_CATCH_ERROR.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_CATCH_ERROR.Handler for executing a workflow action of type
EWorkflowNodeType.FC_CHANGE_FORM_AVAILABILITY.The
INodeHandler for nodes of type EWorkflowNodeType.FC_CHANGE_FORM_AVAILABILITY.Model class for the change form value action (
EWorkflowNodeType.FC_CHANGE_FORM_AVAILABILITY).Model class for the change form value action (
EWorkflowNodeType.FC_CHANGE_FORM_VALUE).Bean for editing the properties of a
EWorkflowNodeType.FC_CHANGE_STATE action in the workflow designer.Handler for executing a workflow action of type
EWorkflowNodeType.FC_CHANGE_STATE.The
INodeHandler for nodes of type EWorkflowNodeType.FC_CHANGE_STATE.Model class for the state change workflow action (
EWorkflowNodeType.FC_CHANGE_STATE).Validator for nodes of type
EWorkflowNodeType.FC_CHANGE_STATE.Handler for executing a workflow action of type
EWorkflowNodeType.FC_COMPRESS_AS_ZIP.The
INodeHandler for nodes of type EWorkflowNodeType.FC_COMPRESS_AS_ZIP.Model class for the compress as ZIP workflow action (
EWorkflowNodeType.FC_COMPRESS_AS_ZIP).Deprecated.
Inject beans directly via
@Inject, use helper classes and static methods directly.Handler for executing a workflow action of type
EWorkflowNodeType.FC_COPY_FORM_RECORD.The
INodeHandler for nodes of type EWorkflowNodeType.FC_COPY_FORM_RECORD.Model class for the state change workflow action (
EWorkflowNodeType.FC_COPY_FORM_RECORD).Handler for executing workflow actions of type
EWorkflowNodeType.FC_COUNTER.Handler for Node of type
EWorkflowNodeType.FC_COUNTERModel class for the workflow action that modifies a counter, see also
EWorkflowNodeType.FC_COUNTER.Handler for executing a workflow action of type
EWorkflowNodeType.FC_CREATE_TEXT_FILE.The
INodeHandler for nodes of type EWorkflowNodeType.FC_CREATE_TEXT_FILE.The properties model for workflow nodes of type
EWorkflowNodeType.FC_CREATE_TEXT_FILE.Handler for executing a workflow action of type
EWorkflowNodeType.FC_DECODE_BASE64.The
INodeHandler for nodes of type EWorkflowNodeType.FC_DECODE_BASE64.Model class for the decode base64 workflow action (
EWorkflowNodeType.FC_DECODE_BASE64).Handler for executing a workflow action of type
EWorkflowNodeType.FC_DELETE_ATTACHMENT.The
INodeHandler for nodes of type EWorkflowNodeType.FC_DELETE_ATTACHMENT.Model class for the delete attachment action (
EWorkflowNodeType.FC_DELETE_ATTACHMENT).Custom label for the
MultiAttachment.getAttachments() property.The
INodeHandler for nodes of type EWorkflowNodeType.FC_RETURN.Model class for the return action (
EWorkflowNodeType.FC_RETURN).Bean with additional logic for controlling the
EWorkflowNodeType.FC_DOI_INIT action.Handler for executing workflow actions of type
EWorkflowNodeType.FC_DOI_INIT.Model class for the workflow action that initializes the Double-Opt-In process.
The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_DOI_VERIFIED.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_DOI_VERIFIED.Bean with additional logic for controlling the
EWorkflowNodeType.FC_EMAIL action.Handler for executing a workflow action of type
EWorkflowNodeType.FC_EMAIL.The
INodeHandler for nodes of type EWorkflowNodeType.FC_EMAIL.Model class for the email workflow action (
EWorkflowNodeType.FC_EMAIL).Helper functions for migrating references to
users in old and new workflow
configurations to the new direct client authorizations.The
INodeHandler for nodes of type EWorkflowNodeType.FC_EMPTY.Handler for executing a workflow action of type
EWorkflowNodeType.FC_ENCODE_BASE64.The
INodeHandler for nodes of type EWorkflowNodeType.FC_FILL_PDF.Model class for the PDF fill workflow action (
EWorkflowNodeType.FC_ENCODE_BASE64).Handler for executing a workflow node of type
EWorkflowNodeType.FC_EXPERIMENT.The
INodeHandler for nodes of type EWorkflowNodeType.FC_EXPERIMENT.The properties model for workflow nodes of type
EWorkflowNodeType.FC_EXPERIMENT.Handler for executing a workflow action of type
EWorkflowNodeType.FC_EXPORT_TO_PERSISTENCE.Controller for the
EWorkflowNodeType.FC_EXPORT_TO_XML action.Handler for executing a workflow action of type
EWorkflowNodeType.FC_EXPORT_TO_XML.The
INodeHandler for nodes of type EWorkflowNodeType.FC_EXPORT_TO_XML.Model class for the change form value action (
EWorkflowNodeType.FC_EXPORT_TO_XML).Deprecated.
since version 8.0.0 where the
native file upload is used.Handler for executing a workflow action of type
EWorkflowNodeType.FC_FILL_PDF.The
INodeHandler for nodes of type EWorkflowNodeType.FC_FILL_PDF.Model class for the PDF fill workflow action (
EWorkflowNodeType.FC_FILL_PDF).Handler for executing a workflow action of type
EWorkflowNodeType.FC_FILL_WORD.The
INodeHandler for nodes of type EWorkflowNodeType.FC_FILL_WORD.Model class for the Word fill workflow action (
EWorkflowNodeType.FC_FILL_WORD).A
Converter for a FormElementModel that is used on the inbox and data table configuration page.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_FORM_SUBMIT_BUTTON.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_FORM_SUBMIT_BUTTON.Handler for executing a workflow action of type
EWorkflowNodeType.FC_POST_REQUEST.The
INodeHandler for nodes of type EWorkflowNodeType.FC_POST_REQUEST.Model class for the HTTP request workflow action (
EWorkflowNodeType.FC_POST_REQUEST).POJO model class for the basic auth credentials of the HTTP request action.
Custom label for the
FcHttpRequestProps.getConnectTimeout() property.POJO model class for the credentials to use with the proxy of the HTTP request action (applicable only when a
proxy is used).
POJO model class for the proxy configuration of the HTTP request action.
Custom label for the
FcHttpRequestProps.getReadTimeout() property.A Hibernate bean validation API resource bundle locator for the
i18n.fc resource bundle.A JAKARTA bean validation API message interpolator for the
i18n.fc resource bundle.The
INodeHandler for nodes of type EWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XML.Model class for the change form value action (
EWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XML).The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_INVITATION_ERROR.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_INVITATION_ERROR.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_INVITATION_SENT.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_INVITATION_SENT.Bean with additional logic for controlling the
EWorkflowNodeType.FC_LDAP_QUERY action.Handler for executing a workflow action of type
EWorkflowNodeType.FC_LDAP_QUERY.The
INodeHandler for nodes of type EWorkflowNodeType.FC_LDAP_QUERY.Model class for the database statement action (
EWorkflowNodeType.FC_LDAP_QUERY).Handler for executing a workflow action of type
EWorkflowNodeType.FC_POST_REQUEST.The
INodeHandler for nodes of type EWorkflowNodeType.FC_LOG_ENTRY.Model class for the log entry action (
EWorkflowNodeType.FC_LOG_ENTRY).The
INodeHandler for nodes of type EWorkflowTriggerType.FC_MANUAL.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_MANUAL.A message that may be shown to the user.
Deprecated.
use
FCMessageHandler for executing a workflow action of type
EWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOX.The
INodeHandler for nodes of type EWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOX.Model class for move the current form record to inbox action
(
EWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOX).Bean for editing formcycle
EWorkflowNodeType.FC_MULTIPLE_CONDITION nodes.Handler for executing a workflow node of type
EWorkflowNodeType.FC_MULTIPLE_CONDITION.The
INodeHandler for nodes of type EWorkflowNodeType.FC_MULTIPLE_CONDITION.The properties model for workflow nodes of type
EWorkflowNodeType.FC_MULTIPLE_CONDITION.Models a single conditions with an operator and one or two operands.
Constraint validation that may be applied to
FcMultipleConditionProps.Defines several
FcMultipleConditionsCustomExpression constraints on the same element.Constraint annotation validator for
FcMultipleConditionsCustomExpression.Constraint validation that may be applied to
FcMultipleConditionProps.getConditions().Defines several
FcMultipleConditionsUniquelyNamed constraints on the same element.Constraint annotation validator for
FcMultipleConditionsUniquelyNamed.Exception welche innerhalb der Plugin-Initialisierung und Abarbeitung geworfen werden kann
Markup annotation for plugin types.
Deprecated.
This exists only because of a bugs introduced in 7.2.1 were the type of this action was changed.
Handler for executing a workflow action of type
EWorkflowNodeType.FC_PROCESS_LOG_PDF.The
INodeHandler for nodes of type EWorkflowNodeType.FC_PROCESS_LOG_PDF.Model class for the process history pdf workflow action (
EWorkflowNodeType.FC_PROCESS_LOG_PDF).Handler for executing a workflow action of type
EWorkflowNodeType.FC_PROVIDE_RESOURCE.The
INodeHandler for nodes of type EWorkflowNodeType.FC_PROVIDE_RESOURCE.Model class for the provide resource workflow action (
EWorkflowNodeType.FC_PROVIDE_RESOURCE).The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_QUALIFIED_FORM_SUBMIT_BUTTON.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_QUALIFIED_FORM_SUBMIT_BUTTON.Handler for executing a workflow action of type
EWorkflowNodeType.FC_QUEUE_TASK.The
INodeHandler for nodes of type EWorkflowNodeType.FC_QUEUE_TASK.Model class for the state change workflow action (
EWorkflowNodeType.FC_QUEUE_TASK).Bean with additional logic for controlling the
EWorkflowNodeType.FC_REDIRECT action.Creates a new executor for executing a forwarding action with the given parameters.
The
INodeHandler for nodes of type EWorkflowNodeType.FC_REDIRECT.Model class for the change form value action (
EWorkflowNodeType.FC_REDIRECT).The
INodeHandler for nodes of type EWorkflowNodeType.FC_RENEW_PROCESS_ID.Model class for the provide resource workflow action (
EWorkflowNodeType.FC_RENEW_PROCESS_ID).Handler for executing a workflow action of type
EWorkflowNodeType.FC_RETURN_FILE.The
INodeHandler for nodes of type EWorkflowNodeType.FC_RETURN_FILE.Model class for the return file workflow action (
EWorkflowNodeType.FC_RETURN_FILE).The
INodeHandler for nodes of type EWorkflowNodeType.FC_RETURN.Model class for the return action (
EWorkflowNodeType.FC_RETURN).Handler for executing a workflow action of type
EWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEM.The
INodeHandler for nodes of type EWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEM.Model class for the save to file system workflow action (
EWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEM).Bean for accessing a root TreeNode for generating a output of directories
Handler for executing a workflow action of type
EWorkflowNodeType.FC_SAVE_TO_WEB_DAVThe
INodeHandler for nodes of type EWorkflowNodeType.FC_SAVE_TO_WEB_DAVModel class for the save to a WebDav provider workflow action (
EWorkflowNodeType.FC_SAVE_TO_WEB_DAV).The
INodeHandler for nodes of type EWorkflowNodeType.SEQUENCE.Markup annotation for controlling initialization of classes inside plugins through the plugin or portal manager.
Handler for executing a workflow action of type
EWorkflowNodeType.FC_SET_SAVED_FLAG.Handler for the Workflow node action that sets the form record to saved
Model class for the workflow node action that marks form records as saved
When an instance field of a test instance is marked with this method, the
FcSystemIntegrationExtension
attempts to inject a value into the field when the test instance is created.Handler for executing a workflow action of type
EWorkflowNodeType.FC_SHOW_TEMPLATE.The
INodeHandler for nodes of type EWorkflowNodeType.FC_SHOW_TEMPLATE.Model class for the show template action (
EWorkflowNodeType.FC_SHOW_TEMPLATE).Bean with additional logic for controlling the
EWorkflowNodeType.FC_SQL_STATEMENT action.Handler for executing a workflow action of type
EWorkflowNodeType.FC_SQL_STATEMENT.The
INodeHandler for nodes of type EWorkflowNodeType.FC_SQL_STATEMENT.Model class for the database statement action (
EWorkflowNodeType.FC_SQL_STATEMENT).Bean for the properties panel of
EWorkflowTriggerType.FC_TIME_POINT trigger workflow elements.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_STATE_TIMER.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_STATE_TIMER.Bean for editing formcycle
EWorkflowNodeType.FC_MULTIPLE_CONDITION nodes.Constraint validation that may be applied to
FcSwitchCaseProps.Defines several
FcSwitchCaseCustomExpression constraints on the same element.Constraint annotation validator for
FcSwitchCaseCustomExpression.The
INodeHandler for nodes of type EWorkflowNodeType.FC_SWITCH.The properties model for workflow nodes of type
EWorkflowNodeType.FC_SWITCH_CASE.A single case value with an operator an a right-hand side that is tested against the switch value.
Constraint validation that may be applied to
FcSwitchCaseProps.getCaseValues().Defines several
FcSwitchCaseUniquelyNamed constraints on the same element.Constraint annotation validator for
FcSwitchCaseUniquelyNamed.The
INodeHandler for nodes of type EWorkflowNodeType.FC_SWITCH.The properties model for workflow nodes of type
EWorkflowNodeType.FC_SWITCH_DEFAULT.Handler for executing a workflow node of type
EWorkflowNodeType.FC_SWITCH.The
INodeHandler for nodes of type EWorkflowNodeType.FC_SWITCH.The properties model for workflow nodes of type
EWorkflowNodeType.FC_SWITCH.A JUnit extension for system integration tests.
Handler for executing a workflow action of type
EWorkflowNodeType.FC_THROW_EXCEPTION.The
INodeHandler for nodes of type EWorkflowNodeType.FC_RETURN.Model class for the return action (
EWorkflowNodeType.FC_THROW_EXCEPTION).Bean for the properties panel of
EWorkflowTriggerType.FC_TIME_POINT trigger workflow elements.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_TIME_POINT.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_TIME_POINT.The settings for the time point when
FcTimePointProps.getTimePointType() is set to
ETimePointType.EXPRESSION_WITH_FORMAT.The settings for the time point when
FcTimePointProps.getTimePointType() is set to
ETimePointType.FIXED.Deprecated.
Use the default
CommonProfile isntead.Converter for formcycle entities that also implement
IUUIDEntity.Model class for the write form record custom attributes action
(
EWorkflowNodeType.FC_WRITE_FORM_RECORD_ATTRIBUTES).Klasse mit den Konstatnen für den Designer
Deprecated.
use
IFormRenderContext and IFormRenderContext-methodsDeprecated.
Deprecated.
Not used anymore by the form designer as it is integrated in JSF now.
Deprecated.
Not used anymore by the form designer as it is integrated in JSF now.
Builder to transform form-data to excel
The result of an transformation of formdata to excel
Deprecated.
use
FdToExcelBuilderBuilder for transforming form-data into XML
The result of an transformation of formdata to XML
Deprecated.
use
FdToXmlBuilderData required for sending a feedback mail.
Requests the current additional placeholders from the active designer tab.
POJO response data for
FetchDesignerPlaceholdersRequest.POJO class for the result returned by
FormTemplateHelper.fetchTagsAndTemplates(Mandant, Locale, IUser, Projekt, FormVersion)POJO class for the result returned by
FormTemplateHelper.fetchTagsAndTemplates(Mandant, Locale, IUser, Projekt, FormVersion)Requests the current web form persist file from the form designer.
POJO response data for
FetchWebFormPersistRequest.Requests the current workflow process from the workflow designer.
POJO response data for
FetchWorkflowConfigRequest.Requests the current workflow persist file from the workflow designer.
Represents a parsed form field name, with the base name, the suffix, and the repetition index.
API class for interaction with files.
POJO class that describes a file conflict, i.e. when a file is copied to a destination, but a file with the same name
exists already at that destination.
General bean for accessing file data of file providing entities.
Deprecated.
A particular
IOException caused by an invalid file formatThe Class FileHandler.
A part or a form item of a
multipart/form-data POST request that is based upon a
FileItem.Deprecated.
use
XFilenameUtilsClass for storing informations and data for an mail-bodypart based on an file
Common wrapper for file providing entities
Default POJO implementation of
IFileSearchOptions.Converter between a file size in bytes and a human readable representation, such as
5.3 MBBean for holding upload information to confirm or cancel a single upload.
When a plain file was uploaded.
Extension to
FileUpload that publishes all validation message as global messages as well (so that they can be
shown in the global p:growl).Utitlity class for working with file uploads.
POJO implementation of
IFileValueDescriptor.POJO implementation of
ITriggerFilterCriteriaForEventParams.Filter criterion supplier builder.
Utility class for generating default filter criterions.
Similar to
org.springframework.boot.test.context.FilteredClassLoader, but ensures that
FilteredClassLoader.getResources(String) does not return excluded resources.Diese Klasse implementiert einen konkreten Zugriffsfilter, der die Standardzugriffsrechte prüft, wie diese in der
Entwicklungsphase definiert wurden.
Requests the existing PDF importer IDs.
POJO response data for
InsertFormElementRequest.Iterable that iterates over all
SubWorkflowElementCategory.getElements() of all
MainWorkflowElementCategory.getSubCategories() of a given main category.Component handler for the flowchart component that can represent a syntax tree-like program as a diagram and also
allows editing.
Base class for the
Flowchart component that contains all the getters and setters for the flowchart's
attributes.Model class for the JSON object that is sent to the client (browser) during a full update of the flowchart.
Helper methods for creating
FlowchartClientConfig and FlowchartUpdateClientConfig for the
Flowchart component.An index of the nodes and triggers in a workflow process.
Represents the JavaScript and CSS resources required by a flowchart element.
JSON converter for the flowchart component, used to convert the data transmitted between the client and server.
Bean for the flowchart component to locate dead workflow nodes.
Model for the
Flowchart component.Helper that converts between the domain model (
WorkflowNode, WorkflowTrigger, etc.) and the view
model for the flowchart component (NodeModel, TriggerModel, etc.)The default renderer for the
Flowchart component.Partial renderer listener for updating the flowchart via a script instead of replacing the entire DOM element.
Event for the
Flowchart component, when the user wishes to save (e.g. by pressing the save key shortcut).Describes the currently selected element of the flowchart.
Represents the serialized version of the flowchart model.
Model class for the JSON object that is sent to the client (browser) during a partial update of the flowchart.
Constants with the bit flags for the different types of edges in a workflow node flow graph.
POJO implementation of
IFlowGraphEndPoints.Filter for the nodes and edges of a workflow node flow graph, used when a traversal operation is performed on a flow
graph, such as when computing the predecessors of a given node.
A
FlowGraphFilter for backward graph traversals.A
FlowGraphFilter for forward graph traversals.A
FlowGraphFilter for a generic graph traversal, starting at some nodes.Contains some common implementations of
flow graph filters.Deprecated.
AJAX request resolver for determining if a FORM request is an AJAX request.
Deprecated.
Use
FormAjaxRequestResolver instead.Generates a script for loading form via ajax
Kopieren einer 'FormVersion' per Alias Aufruf (alle Formulartypen)
Alias-Auslieferung einer 'FormVersion' (alle Formulartypen)
Generates a script for loading form via the form include API (see include.js)
The authentication context for an form
Builder for creating an
IFormAuthContextFactory to create authorizers based on an
IFormAuthContext and an ProjektUtilities for saving and loading form backups.
POJO model for the form version backup available in the form designer.
Similar to a
SelectItem, but immutable and with a type-safe FormBackupVersion.getValue() method for a form backup
version.Factory for creating Pac4j
Clients.Wrapper for authenticator configs of type
EAuthClientType.FORMKopieren einer 'FormVersion' (alle Formulartypen)
Utilities for analyzing CSS classes and fetching CSS themes, see
FormDesignerCssBean.Callable for update of the entire system.
Bean for switching the formcycle scope of the view.
API-Klassse zum Umgang mit
IFormDataAdapter-ElementenThe Class FormDataHandler.
Handler for designer events
Bean for the form designer.
Bean for the form designer.
Handles designer conversation events that are relevant to the form designer.
Conversation request handler bundle for the form.
Bean for the form designer.
A new POJO for
IFormDesignerEnvironmentData.When the language used to edit the form has changed.
Controller bean for the form designer handling the language.
POJO model for the form designer, contains the selected language and the available languages.
POJO model holding the data required for the form designer.
Bean for the new designer.
Utility methods for creating the various models used by the form designer.
Bean for the form designer.
Bean for the form designer.
Controller bean for the form designer handling refactorings in form element names etc.
Bean for the form designer.
Bean that is invoked when the form designer is opened.
Controller bean for the form designer handling changes to the form persist JSON.
Bean for the form designer.
FormEingabeDaten +- Vorgang +- Eingangsinformationen (Datum, Nutzer) +- Mapping der Feldnamen-Aliasse auf die
zugehörigen Werte
API class for manipulation of
FormEingang entities.The Class FormEingangHandler.
API class for manipulation of
FormElement entities.The Class FormElementHandler.
Used by the PDF importer, list of elements that are near the elements to insert.
Bean for configuring the print export of projects
Exporter for creating documents from formcycle forms
View Model for data of a form record field
Service for creating the view model for displaying form record data
Forward-Alias-Auslieferung einer 'FormVersion' (alle Formulartypen)
Factory for getting
form functions instances for built-in functions.Exception thrown when a form function could not be parsed when it is syntactically invalid.
Parses a form field function, used by placeholders and by the Word fill workflow action, e.g.
Class for different helper-methods for the usage with forms
Model für Darstellung einer Node im FormImpex-Tree
When the persist JSON of a single items was modified.
Helper methods related to the languages available for a form.
Default POJO implementation of
IFormLifecycleShouldExecuteParams.POJO model holding data related to the current form edited in the designer.
Helper for creating and working with the form overview table in the designer.
Model for preferences of a
UserProfile regarding the form overview.POJO model for the form element overview table in the designer.
Deprecated.
POJO model for storing the current form persist JSON, with a few utility methods.
When the persist JSON was modified of the entire form was modified.
Context of an form-persist-request with data after the persist-call
Builder for creating a form-persist-context.
Class with data for ein form-persist-request
Helper for working with the form persist JSON from the client, such as applying increment patches.
Class with request-data for a form persist request
Deprecated.
plugins invoked by their corresponding contexts!
Bean for configuring the print export of projects
Helper for converting a formcycle form into a PDF form.
This servlet returns the preview (thumbnail) image for a given form or form template.
Absenden eines Formular für die Vorschau
Auslieferung einer 'FormVersion' für den Druck(alle Formulartypen)
Context of an form-process-request with data after the processing
Builder for creating an form-process-context.
Class with data for an form-process-request
Class with request-data for an form-process-request
Helper class for Form processes
allgemeines Servlet für die Auslieferung (den Aufruf) von Formularen mit beliebigem
FormTypContext of an form-publish-request with data for an publish-call
Builder for creating an form-publish-context.
Utilities for publishing (saving) a form version, see also
FormDesignerPublishBean.publishForm().Model class for form record base data
Factory for creating models for specific form record data
Model holding the Double opt-in details that were used to initialize the Double opt-in process of a form record
Model holding the Double opt-in details that were used to send the email initializing the Double opt-in process
Default implementation of
IFormRecordFormDataView model for displaying the details of a form record quartz job
Wrapper class for displaying form records in the
Simple table that holds potentially long-term locks on a form record.
Acquires a form record lock on creation and releases it when the context is closed
The default implementation of
IFormRecordLockDao that can be accessed via DaoProvider.Deprecated.
Form records are locked via
Vorgang.isInArbeit().Result returned by
FormRecordLockManager.lockFormRecord(Vorgang).Model class for form record review data
Wrapper class for form record selection
Default implementation of
IFormRecordWorkflowDataContext of an form-render-request with data for an renderer-call
Builder for creating an form-render-context.
Class with data for an form-render-request
Helper methods for rendering form element for the form designer.
Class with request-data for an form-render-request
Class with data for an form-request
Context of a form-request with all data for working with further contexts like
IFormRenderContext,
IFormPersistContext or IFormProcessContextBuilder for creating an form-request-context.
Factory for creating different form-contexts
Class with request-data for an form-request
Class for validating an
IExtendedFormRequestContexts by checking usage-privilegesDeprecated.
This class is part of the old workflow engine and will be removed together with it soon.
Liefert eine (Nur-Lese-)Sicht für Postfachbearbeiter, die eingegebene Formulardaten zu einem bestimmten Vorgang
anzeigt.
Bean for exporting a copy of the form.
Builder for the event data for a form submission event, i.e. when the user clicked on a submit button.
Utilities for finding, adding and deleting form templates in the form designer, see
FormDesignerTemplateBean.Deprecated.
Use
IUser to get user data.Deprecated.
Use
IUser to get user data.Deprecated.
Use
IUser to get user data.Models a form variable that can be created in the form designer.
The verify servlet is used for the double opt-in link.
Die Entität FormVersion ermöglicht es verschiedene Versionen eines Formulars zu verwalten.
API class for manipulation of
FormVersion entities.The default implementation of
IFormVersionBackupDao that can be accessed via DaoProvider.The Class FormVersionHandler.
Deprecated.
Deprecated.
Updates the theme reference on
FormVersions from its name to UUIDConversation request handler bundle for the designer frame.
POJO model holding the data required for the main designer frame page containing the sub pages such as the form and
workflow designer.
Class that is used to find the free slots of an
AppointmentTemplate in a given time range, excluding slots
already blocked by an Appointment.Builder for a
IAppointmentFreeSlotQueryParams.Filter that adds security-relevant headers and other settings for the frontend (web forms).
API class for manipulation of
FrontendServer entities.The Class FrontendServerHandler.
Bean for providing frontend servers of clients.
Redirects to the clients final callback URL while adding the
frid parameter.Generator for FRQ session values.
Deprecated.
Use
FRQSessionStateGenerator instead.Pac4j
SessionStore implementation for FRQSessionsDeprecated.
Use
FRQSessionStore instead.Klasse mit der Implementierung der RMI-Mehtoden
Klasse zum Verbinden und Trennen der Verbindung mit dem FServer
API class for manipulation of
FrontendServer entities and API-Klassse zur Manipulation von
FrontendServer-Entitäten und to invoke the appropriate connect / disconnect and connection testing operationsThe Class FSConnectionHandler.
Servlet to monitor and establish an frontend server connection.
ContextListener-Implementierung für XFC-spezifische Funktionalitäten zum Webapp-Start und -Ende.
Servlet context listener for the plain frontend server (without inbox) for executing initialization and shutdown
tasks that are specific to plain frontend server web applications.
Implementation of
IHandlerProvider for the frontend server.Servlet context listener for the frontend server inbox for executing initialization and shutdown tasks that are
specific to frontend server inbox web applications.
Class for setting up the frontend server inbox security.
Diese Klasse implementiert einen Frontendserver gegen den sich verbunden werden kann.
Klasse mit der Implementierung der RMI-Mehtoden
Deprecated.
Filter for protecting critical views such as system configuration views and the user profile page.
Contains the mapping between Word fill function names and the corresponding handlers for executing those functions.
Helper functions for Gagawa DOM
Node, such as iterating in depth-first pre-order, finding elements by certain
conditions, or reading or setting node data.Workaround to access protected objects from Gagawa, to work around bugs or missing features.
A
ITreeAccessor for Gagawa DOM Nodes.Deprecated.
This is part of the old rest API.
Generic API class for manipulation of entities.
API class for interaction with cache
Utility class for working with entities
Deprecated.
Handles application events that are relevant to all designer pages.
Generic designer conversation event listener that handles common events for all designer pages.
Bean that sets up listeners for DAO related events and forwards them to the
ApplicationEventBusBean.Describes the data of a generic form persist file, whose exact meaning has yet to be determined.
The Class GenericHandler.
Generic project overview conversation event listener that handles common events for the project overview.
Deprecated.
This is part of the legacy REST API that will be removed at some point.
An HTTP session listener to clean the XFC form request user session (after a logout or session timeout).
Similar to
StringTrimConverter, but does not register itself automatically and Object as its target
type.POJO with parameters for
IWorkflowProvider.getAvailableAttachments(NodeKey, GetAvailableAttachmentsParams).A simple builder for configuring a
GetAvailableAttachmentsParams POJO.Default POJO implementation of
IGetDisplayLabelParams.POJO implementation of
IGetElementPrototypesParams.Default POJO implementation of
IGetElementSummaryParams.Default POJO implementation of
IGetFilterCriteriaForEntitiesParams.Model for a request to fetch all or some subset of store items from a particular store.
A builder for a
GetStoreItemsRequest.POJO implementation of
IGetWidgetResourceParams.GoogleAuthenticatorProperties<TAuthenticator extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for the properties of an authenticator of type
EAuthClientType.GOOGLE.GoogleWrapper<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Deprecated.
Use
GoogleAuthenticatorProperties instead.Deprecated.
Use
XGraphUtilsAdapter for serializing and deserializing
Date objects with GSON.A collection of
TypeAdapters for java.time.* classes.Type adapter for
Duration.Type adapter for
LocalDate.Type adapter for
LocalDate.Type adapter for
LocalDateTime.Type adapter for
LocalTime.Type adapter for
MonthDay.Type adapter for
OffsetDateTime.Type adapter for
OffsetTime.Type adapter for
Period.Type adapter for
Year.Type adapter for
YearMonth.Type adapter for
ZonedDateTime.Type adapter for
ZoneId and its subclasses.Deprecated.
Use
WriterTypeFactory or ReaderTypeFactory insteadDeprecated.
Type factory for FC entity types for GSON deserialization
Default implementation of
IGuiIcon for common icon libraries.Model for a GUI image with a source and an alternative description.
Class to determine and check the hardware-id
An exception that indicates that a certain operation cannot be performed on an entity, due to that entity still being
reference by other entities.
Authorizer that checks if the user is part of the given user groups
Represents the parameters of form HTTP request as key-value pairs.
Utility class for dealing with
Hibernate objectsPOJO model for receives updates from the client regarding updates to the redo / undo buttons.
Represents an HSLul color triplet, see https://www.hsluv.org/
Represents an HSV color triplet.
An HTML editor component which may be implemented by different libraries.
Properties for the
HtmlEditor.Renderer for the
HtmlEditor component.CDI-injectable provider for the HTML templates available during workflow editing and validation.
General logic for HTTP requests.
POJO implementation of
IHttpContextData with a builder.Builder for creating an immutable instance of
IHttpContextData.A custom HTTP method with the given method name.
Deprecated.
Use
HttpRequestBuilder.Builder for preparing and sending an HTTP request.
An HTTP request parameter with a name and value that can be added to a request.
Wrapper for a
CloseableHttpResponse which provides a couple of convenient methods for working with the
responseAn
IRequestContext backed by an actual HttpServletRequest.HTTP servlet request that wraps another servlet request, but with a changed parameter map.
Statische Klasse der auf Serverseite benutzen i18n-Keys
Schlüssel für lokalisierte Standardwerte.
Schlüssel für lokalisierte Fehlermeldungen.
Schlüssel für lokalisierte Hinweise, Nachrichten, Eingabeaufforderungen und Bezeichnungen.
Schlüssel für Texte innerhalb von Protokollen
Resource handler for i18n resources required by the client.
Update of the i18n variable 'lettersLeft' for the new input element counter api on a textarea element.
System update for migration old text-templates 'FD2_I18N' to new 'I18N_VARIABLE' templates.
Builder for the result of a node that was completed abruptly by throwing an exception or issuing a return statement.
Deprecated.
use
IFileEntityDeprecated.
Interface for user-role and license-based access-properties
Represents an option of a
IPdfAcroField.Choice.Interface for types whose instances indicate whether they are active or not.
Deprecated.
This is part of the old workflow, use the new workflow engine.
Deprecated.
A
IValueBuilder for creating a value of any type.A
IValueDescriptor for a value of any type.A
IValueDescriptorBuilder for creating a value descriptor of any type.Interface for remote API-handlers
Extension of the session event which are able to be posted through the API.
Common interface for logging appenders
Represents part of the result of a query that retrieves the available times of a
AppointmentTemplate.Represents the base parameters for booking, updating, or cancelling an appointment.
DAO for reading and writing
AppointmentClientClosingTime entities.Common interface for
AppointmentTemplate closing times.DAO for reading and writing
IAppointmentClosingTime entities.Represents the parameters for creating (booking) a new appointment.
DAO for reading and writing
Appointment entities.Interface that represents part of the data of an appointment.
Represents the parameters for deleting (cancelling) an existing appointment.
Interface for the appointment servlet.
The parameters for a query that retrieves the available times of a
AppointmentTemplate.Represents the result of a query that retrieves the available times of a
AppointmentTemplate.Handler for
Appointment entities.Interface that abstracts the database interaction required by the ical servlet, to allow for easier mocking during
testing.
The parameters for a query that retrieves the available appointments of a
AppointmentTemplate as an iCal
file.Represents the result of a query that retrieves the available appointments of a
AppointmentTemplate as an
iCal file.Represents the parameters for the appointment booking handler when the date or time of an appointment is to be
changed.
Parameters for the appointment DAO for querying existing appointments.
A view of an
Appointment that includes only the start and end time.DAO for reading and writing
AppointmentTemplate entities.Handler for
AppointmentSlot entities.Marker interface for an object that can be used to retrieve an appointment.
DAO for reading and writing
AppointmentTemplate entities.Interface that represents relevant data of an appointment.
Handler for
AppointmentTemplate entities.DAO for reading and writing
AppointmentType entities.Handler for
AppointmentType entities.Represents the parameters for validating an appointment about to be persisted.
Interface that abstracts the database interaction required by the validation process of the appointment booking
handler, to allow for easier mocking during testing.
Deprecated.
This is part of the old workflow engine.
Common interface for both the resolved attachment list and each resolved attachment item, which both provide access
to the errors that occurred.
Options that influence how attachments are retrieved by
IWorkflowFileHandler.resolveReferencedAttachments(WorkflowNode, IReferencedAttachmentList, IAttachmentSearchOptions) (WorkflowNode, IReferencedFileList, IAttachmentSearchOptions) resolveReferencedFiles}.Descriptor for the attachments created by a workflow node when it is executed.
Interface for the POJO model class of workflow actions that can create files and offer an option to attach these
created files to the form record.
Common interface providing information about a users authentication.
Common interface describing the target of an authentication request e.g.
IAuthenticator<T extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>
Common interface for user authenticator entities.
Common interface for accessing parameters of authenticator attributes
Common interface for clients of an authenticator.
Common interface for authentication config entities
Common interface for context data need for rendering authenticator configs
Common interface for authenticator config renderers that are used to create the rendered HTML for an authenticator
config.
Common interface for authenticator config wrapper
IAuthenticatorProperties<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Common interfaces for models representing the properties of an
IAuthenticator.IAuthenticatorWrapper<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Deprecated.
Use
de.xima.fc.security.interfaces.authentication.IAuthenticatorProperties instead.IAuthentticatorFile<E extends de.xima.cmn.dao.interfaces.IEntity<Long>,T extends IFileDataEntity<?>>
Common interface for context data needed in
IAuthorizers to check the authorization of users to a web
endpoint.Common interface for authorization filter models of
IndirectClientAuthorizations.Common interface for authorizers.
Common interface for models that cover the web context for an authentication target and allow for access to commonly
used objects in pac4j authentication flows.
Common interface for parameters needed to check the availability of a web endpoint.
Common interface for resolving the availability of web endpoints.
Mixin for nodes that wish to register the default client-side action handlers.
Node logic handler for actions with a properties model that inherit from
BaseActionProps.Represents any result of
INodeHandler#execute, regardless how
execution finished (normally or abruptly).Mixin for nodes that wish to register the default client-side condition handlers.
Environment data with basic info for within various backend environments.
DTO interface for login configurations.
DTO interface for login page configurations.
Trigger handler for triggers with a properties model that inherit from
BaseTriggerProps.Environment data required when create node or trigger prototypes.
Context object that contains data related to the current execution of the workflow processing.
Base interface for the available configuration parameters of a plugin bundle.
Common interface for identifying a
VorgangDeprecated.
This is part of the old rest API.
Handler for the various different bean scopes, such as session scoped beans or view scoped beans.
Mixin that implements
IElementHandler.validateLocal(IElementLocalValidationParams) by performing a bean
validation on the IWorkflowElementWithDeserializedModel.getData().Mixin that implements
IElementHandler.validateLocal(IElementLocalValidationParams) by performing a bean
validation on the node's properties model.Mixin that implements
IElementHandler.validateLocal(IElementLocalValidationParams) by performing a bean
validation on the trigger's properties model.Deprecated.
This is part of the old workflow, use the new workflow engine.
Deprecated.
Since Version 8.0.0 user information is stored
UserProfiles.Schnittstelle für Modelklassen, die in Beziehung zu BenutzerGruppen stehen.
Deprecated.
The
Benutzer has been replaced by UserProfile.Deprecated.
This is part of the old rest API.
A builder for an HTTP request body that can have binary data items, such as a multipart body.
A
IValueBuilder for creating a boolean value.A
IValueDescriptor for a boolean value.A
IValueDescriptorBuilder for creating a boolean value descriptor.Mixin for all built-in workflow node handlers.
Adds default implementations for
IElementHandler.getJavaScript(boolean) and
IElementHandler.getCascadingStyleSheet(boolean).Mixin for all built-in workflow trigger handlers.
Interface für (Jar)Bundle-Konfigurations-Parameter
Provides a list of all the plugin bundle properties used to display in the configuration view.
Factory for creating iCal String data
Method for escaping text inside ICAL files.
Deprecated.
will be removed
Common interface for callback logic.
Executor with the logic for creating iCal files with appointments.
Generic Servlet for generating iCal files
Interface for quartz job details for state change jobs of the old workflow.
Handler for
ClientAuthenticator entities.Common interface for authorization to a
Mandant .DAO for reading and writing
IEntityClientAuthorization entities.Common interface for DAO of
ClientCountersHandler for
ClientCounter entitiesInterface for classes which should create clients
Common interface describing an authentication client.
Interface for an object that is able to locate the resources required by a flowchart element (node or trigger).
Data access object for creating, updating, and deleting
ClientPlugin entities.Common interface representing context data needed for client scoped
IUriResolvers.Models a cluster with one or more nodes that can communicate with each over.
A listener that can be used to react to events related to changes in the channel of a cluster, e.g. when a connection
to a node was established or cut; or when a channel was closed.
An observer that can be used to listen for changes to the channel state, such as when the connection a node was
established or cut.
Models the connection between nodes in the cluster.
Base interface for messages that can be exchanged between nodes in a cluster.
A listener that can be used to react to events related to when messages are sent between nodes in the cluster.
An observer that can be used to listen for messages exchanged by nodes in the cluster.
A listener that can be used to react to events related to changes in the topology of a cluster, e.g. when a node as
added or removed.
An observer that can be used to listen for changes to the cluster topology (e.g. when a node is added or removed from
the cluster).
Represents a field supported by each
IGuiColor of a color palette.Builder for the result of a node when it was executed, either successfully or abruptly.
Used with the composite component
convertible.POJO interface with the with parameters for
CompoundConditionEvaluator.test(ICompoundConditionData).Parameters that are passed to
ICrossViewScopeResponseSupplier.computeRequestedData(IComputeRequestedDataParams).Common interface for console appenders
A
IValueBuilder for creating a constant value.A
IValueDescriptor for a constant value.A
IValueDescriptorBuilder for creating a constant value descriptor.Interface for all workflow actions that require files to perform their job.
Deprecated.
This is part of the old workflow engine.
API for interacting with contact resources via PROMA (product manager).
A builder for an HTTP request body that can have parameters with different content types, such as a multipart body.
Map like interface for the
IComponentValueConverter.Common interface for counter entities
Context provided to the node handlers during a call to
createFlowGraph.Interface for the parameters that are passed to
createFlowGraph of
IWorkflowNodeFlowAnalyzer.Parameters that are passed to the
isCreateProtocolEntryAfterExecution method of a INodeHandler to decide whether a protocol entry should be
created.Builder for configuring a
EWorkflowNodeType.FC_CREATE_TEXT_FILE action.Base interface for a cross-view scope request for a piece of data.
Handles a cross view scope request for a piece of data.
Result from a cross view scope request for a piece of data.
Processes the response obtained for a cross view scope request.
POJO data passed to
ICrossViewScopeResponseConsumer.accept(ICrossViewScopeResponseData).Creates the response to a cross scope request.
Body builder for writing custom content to an HTTP request
API for interacting with customer resources via PROMA (product manager).
Interface for entities that provide custom parameters stored as a JSON string.
Interface meant to be used along with
ICustomParametersProviding for updating the custom parameters that were
created with a previous version of the software product.Schnittstelle zu den konkreten Formulardaten.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Callback interface for updating data held within this container
Deprecated.
This is part of the old rest API.
The Class DataStoreHandler.
Interface für Datenquellen-Parameter
Deprecated.
This was renamed.
Trigger handler for triggers that wish to register the default client-side handlers.
Deprecated.
Deprecated.
Event for informing about the result of an identity check.
Bean for accessing authenticators of external identity providers.
Common interface for all objects (mainly entities) that have got a human-readable description.
Deprecated.
Implement
IFCPlugin instead and use IFCPlugin.getDescription(java.util.Locale).Base interface for all designer conversation events.
Base interface for all designer conversation events.
DAO for reading and writing
DirectClientAuthorization entities.Handler for
DirectClientAuthorization entitiesRepresents a member of a discriminated union, in the form of tuples
(Discriminator, Value).Interface for the data to be used in a double opt-in verification event.
Interface for the result of the verification of a Double Opt-In process of a form record.
Interface for the event when an initialized double opt-in process (see
EWorkflowNodeType.FC_DOI_INIT) has
been confirmed.Interface for the
Appointment that can provide its effective EAppointmentStatus.Models a category for a workflow element, such as a node or trigger.
Interface for the parameters that are passed to
IElementHandler.validateGlobal(IElementGlobalValidationParams).All element handlers must be thread-safe.
Models the location of the help page for a workflow element.
Interface for objects that have got a UUID identifying them.
Interface for the parameters that are passed to
IElementHandler.validateLocal(IElementLocalValidationParams).Interface for element prototypes, i.e. for elements that can added to the flowchart via drag & drop.
The interface of a bean for editing the properties of workflow elements.
Parameters that are passed to
prepareViewForElement.The data that is used to create a new workflow element when an element prototype is dragged into the workflow
designer.
A prototype for a workflow element (node or trigger) that is shown in the drawer panel in the workflow designer.
View wrapper model for the elements drawer panel.
Interface for objects that have got custom search terms for database queries.
Parameters that are passed to
IElementPropertiesBean.updateCurrentProperties(IElementUpdateCurrentPropsParams).Parameters that are passed to
IElementPropertiesBean.updateCurrentTask(IElementUpdateCurrentTaskParams).Represents a workflow element together with the
WorkflowTask to which it belongs.Builder for configuring a
EWorkflowNodeType.FC_EMAIL action.Deprecated.
Entity does not exist anymore.
Common interface for authorization to a
Mandant that are entities.Interface for the
IEntityContext which is required for database transactions.Wrapper for an
IEntityContext that allows the context to be closed and opened again.Interface for dependencies of entities that have not not yet been resolved
Extension for hooking into the deserialization of entities e.g. for considering deprecated fields
Common interface for parameters needed for entity deserialization
Common interface representing the result of an entity deserialization
Common interface for entity exporters
Interface for entity import configurations
Common interface for data needed for initialization of
IEntityImportConfigsDeprecated.
Use
ProjectImporter insteadDeprecated.
Describes a list of entities of which one can be selected.
Common interface for entity metadata.
Interface for events that occur when an entity was changed.
Interface for creating an
IEntityModifiedEvent for a given modified entity.Interface describing an entity reference and its location
IEntityListModel describes a list of entities of which one can be selected.Common interface for entity sorting criterion suppliers for use in
DaoLazyDataModel.Common interface for entity view models
Common interface for entity wrappers
Deprecated.
This is part of the old rest API.
Error data provided by a workflow node either when
INodeHandler#execute throws an exception or completes normally with soft
errors.Common interface for events.
Represents the result returned by the
IWorkflowEventRunner.Common interface for API event handlers.
Represents the result of
INodeHandler#execute when the node was
completed abruptly by throwing an exception.Common interface for accessing the result of an exclusive form record lock request
Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
have no children and simply execute some business logic.Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
execute one of its two children based on a test, such as an if-else node.Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
attempt to execute its child, and run another child if the child completed abruptly by throwing an exception, such as
a try-catch(-finally) block.Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
execute children like a switch.Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
have no children and always complete abruptly by either throwing an exception or issuing a return statement.Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
have no children and always complete abruptly by issuing a return statement.Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
have no children and always complete abruptly by issuing a return statement.Mixin with the implementation of
IWorkflowNodeFlowAnalyzer.createFlowGraph(ICreateFlowGraphParams) for logic handlers that
have no children and always complete abruptly by throwing an exception.Each action may create data when it is executed, that describe the result of the action.
Common interface for results of unzipping formcycle export files
Interface for extending form-contexts with
HttpServletResponse and HttpServletRequestA parameter model with additional settings such as group items.
Parameters that are passed to
IElementHandler.extractSearchTerms(IExtractSearchTermsParams).Interface for a handler that performs serialization and deserialization via
JSON.Options for the
IFastJsonConverter.toJsonString(Object, IFastJsonSerializeOptions).The result descriptors for the data returned by the
EWorkflowTriggerType.FC_CATCH_ERROR action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_POST_REQUEST action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_CHANGE_FORM_VALUE action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_CHANGE_STATE action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_POST_REQUEST action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_COPY_FORM_RECORD action.The result descriptors for data returned by
EWorkflowNodeType.FC_COUNTER actions.The result descriptors for the data returned by the
EWorkflowNodeType.FC_CREATE_TEXT_FILE action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_FILL_PDF action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_DELETE_ATTACHMENT action.The result descriptors for data returned by
EWorkflowNodeType.FC_DOI_INIT actions.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_DOI_VERIFIED action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_EMAIL action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_FILL_PDF action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_EXPORT_TO_XML action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_EXPORT_TO_XML action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_FILL_PDF action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_FILL_WORD action.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_FORM_SUBMIT_BUTTON action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_POST_REQUEST action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_IMPORT_FORM_VALUE_FROM_XML action.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_INVITATION_ERROR action.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_INVITATION_SENT action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_LDAP_QUERY action.The result descriptors for data returned by
EWorkflowNodeType.FC_LOG_ENTRY actions.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_MANUAL action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_MOVE_FORM_RECORD_TO_INBOX action.Base interface that all formcycle plugins must implement.
The result descriptors for the data returned by the
EWorkflowNodeType.FC_POST_REQUEST action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_PROVIDE_RESOURCE action.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_QUALIFIED_FORM_SUBMIT_BUTTON
action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_QUEUE_TASK action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_REDIRECT action.Markup interface for plugins which need to be synchronized with the frontend server.
The result descriptors for the data returned by the
EWorkflowNodeType.FC_RENEW_PROCESS_ID action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_RETURN_FILE action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_SAVE_TO_FILE_SYSTEM action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_SET_SAVED_FLAG action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_SHOW_TEMPLATE action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_SQL_STATEMENT action.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_STATE_TIMER action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_THROW_EXCEPTION action.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_TIME_POINT action.Deprecated.
Use
IUser or default UserProfiles instead.The result descriptors for the data returned by the
EWorkflowNodeType.FC_WRITE_FORM_RECORD_ATTRIBUTES action.Provider for accessing appointments and appointment templates when a form is rendered.
Handles the plugin render callbacks when rendering a form.
Provider for accessing templates
Interface for formdata transform builders to create an export of formdatas
Interface of the result of an formdata transformation
Body builder for writing the content of an file to an HTTP request
Common interface for classes providing a file map
Deprecated.
This should be implemented together with
getSuccessValueDescriptor etc., e.g. in a separate specific mixin interface for the node handler.Options that influence how files are retrieved by
resolveReferencedFiles.Descriptor for the files returned when a workflow node is executed.
Builder for configuring a
EWorkflowNodeType.FC_FILL_PDF action.Common interface for logging filters
Common interface for entity filters for use in
DaoLazyDataModel.A
IValueBuilder for creating a 64-bit floating point value.A
IValueDescriptor for a float value.A
IValueDescriptorBuilder for creating a 64-bit floating point value descriptor.Interface for an object that is able to locate dead workflow nodes.
Data associated with an edge of a flow graph, see
ITaskFlowAnalysis#getFlowGraph and INodeHandler#createFlowGraph.Builder for the
edge data of a flow graph, used when
building a flow graph via the connect
methods from ICreateFlowGraphContext.Represents the result of
IWorkflowNodeExecutionAnalyzer#createFlowGraph, i.e. the set of all successor nodes to which a node can transfer
control when executed.Filter for the nodes and edges of a workflow node flow graph,to exclude some existing nodes or edges.
Interface of an form based authentication context
Meta data about a repeated form element.
Interface for form data.
Interface for
IWorkflowEventData that contains IFormDataAdapter.A builder for an HTTP request form data body (
application/x-www-form-urlencoded).Environment data required within the form designer.
Interface for form function handlers that can evaluate a form function.
Interface for an form field functions replacer
Exception where the
IXfcException.getMessageKey() points to a key in the form I18N messages.Filter for checking whether a built-in or plugin widget form element should be included or excluded.
Parameters passed to form lifecycle plugins when they are executed.
Base interface for plugins which hook into the lifecycle of the form, such as pre-render or pre-process plugins.
Parameters passed to form lifecycle plugins to check whether they should be executed for a given form request.
Context after persisting a form.
Context after processing an form
Context for publishing an form
Common interface for base data of a form record.
Common interface for accessing form records and their meta data
Data interface for transferring the Double opt-in details that were used to initialize the Double opt-in process
Common interface for accessing the field data of a form record.
Common interface for accessing form data information of a form record
Common interface for accessing the form record data of a specific form element item.
Common interface for detail information about quartz jobs of a form record
Common interface for models for form record quartz jobs
Common interface for a form record locking context that can acquire a lock on a form record and which needs to be
released when the context is closed
Data access object for creating, updating, and deleting
WorkflowTask entities.Common interface for form record entity meta data.
Interface for
IWorkflowEventData that belong to a form record, such a when a form is submitted, or when the
active WorkflowState of a form record changes.Common interface for accessing the review data of a single form record.
Common interface representing context data needed for form record scoped
IUriResolvers.Common interface for accessing the form record data of a specific variable.
Common interface for accessing the workflow data of a form record
Wrapper interface for form records
Context for rendering an form
Callback that allows the form render process to be customized.
A class with the relevant data of a form request, such as the current form or the authenticated user.
Interface for the event when a form was submitted via an HTTP request.
Common interface representing context data needed for form version scoped
IUriResolvers.Interface of RMI-methods which are available on the master-server
The Class FSConnectionHandler.
Interface of RMI-methods which are available on the master-server
Interface of the client-session on the frontend-server after authentication
Arguments of a function to evaluate.
Data access object working for different kinds of entities that provide binary file content.
The Class GenericHandler.
API for basic interactions via PROMA (product manager).
Parameters that are passed to
IElementHandler.getDisplayLabel(IGetDisplayLabelParams).Parameters that are passed to
INodeHandler.getNodePrototypes(IGetNodePrototypesParams) and
ITriggerHandler.getTriggerPrototypes(IGetTriggerPrototypesParams).Parameters that are passed to
IElementHandler.getElementSummaryModel(IGetElementSummaryParams).Parameters that are passed to
IElementHandler.getFilterCriteriaForEntities(IGetFilterCriteriaForEntitiesParams).Parameters that are passed to
INodeHandler.getNodePrototypes(IGetNodePrototypesParams).Parameters that are passed to
ITriggerHandler.getTriggerPrototypes(IGetTriggerPrototypesParams).Parameters passed to
IXItemWidget.getJavaScriptData(IGetWidgetResourceParams) andCommon interface for
Gson deserialization of FC entitiesRepresents the guessed content type of a file or data stream.
Interface for the color entries provided by a color palette.
Represents an icon used in the fronted.
The interface for the instance that provides access to an instance of the various different remote handlers.
API for interacting with hardware ID resources via PROMA (product manager).
Mixin that implements
IElementHandler.validateLocal(IElementLocalValidationParams) by performing checks on the
number of children and the type of the children, as well as the type of the parent (if any).A builder for an HTTP request body.
Details on an HTTP request that is serializable and can be transferred between servers.
Interface for
IWorkflowEventData that are triggered in the context of an HTTP request.Builder for configuring a
EWorkflowNodeType.FC_POST_REQUEST action.Interface for objects that have got an ID identifying them.
Processes the raw image of a PDF page into the desired format, e.g. a PNG image or base64 data URL etc.
Options for creating images from a PDF document.
Interface to use in
ImportValueConverter to define how deprecated entity fields should be convertedDeprecated.
Use the new workflow engine (
IWorkflowEventRunner).Common interface for form record events that occur inside the inbox
Common interface for requests of a single form record from inside the inbox
Allgemeine Schnittstelle für indexbasierte Entitäten.
DAO for reading and writing
IndirectClientAuthorization entities.Handler for
IndirectClientAuthorization entities.The indivdual conditions to combine.
Interface for the node prototypes that should be set when a new task is created.
A
IValueBuilder for creating an integer value.A
IValueDescriptor for an integer value.A
IValueDescriptorBuilder for creating a 64-bit integer value descriptor.Common interface for handling invalid credentials during authentication.
Interface for the event when an error occurred while trying to send an invitation to a form record.
Interface for the event when a form record invitation has been sent successfully.
A serializable supplier for a value that may throw an
IOException.The parameters that are passed to
IElementHandler.isAvailable(IIsAvailableParams).Specialized entity sorting criterion for sorting via in Java.
Interface for data of an scheduling-task
Interface for a class that behaves like a JSON object in that it has key value pair.
IKeyDependentFileEntity<E extends de.xima.cmn.dao.interfaces.IEntity<Long>,T extends IFileDataEntity<?>>
Common interface for
IFileEntitys that depend on a file keyMixin that implements
IElementHandler.getElementSummaryXhtml() and
IElementHandler.getElementSummaryModel(IGetElementSummaryParams) for nodes and triggers that wish to provide
a simple key value based overview.A
IKeyValueSummarizableElement for workflow nodes.A
IKeyValueSummarizableElement for workflow nodes.Common interface for instances that can provide a
languageTag.A
IValueBuilder for creating a large string value.A
IValueDescriptor for string value.A
IValueDescriptorBuilder for creating a large string value descriptors.Common interface for appender layout configs
Adapter for a lazily loaded PrimeFaces tree.
Deprecated.
Since Version 8.0.0 LDAP access to
Mandants is stored in IndirectClientAuthorizations.API for interacting with license resources via PROMA (product manager).
Context for handling liquibase tasks and closing the used resources afterwards
A converter for the
Tagify component.Interface for registering listeners that perform setup logic.
A
IValueBuilder for creating a list value.A
IValueDescriptor for a list value.A
IValueDescriptorBuilder for creating a list value descriptor.Common interface for all objects (mainly entities) that have a locking version.
Common interface for logging configs
Common interface for Logger configs
Deprecated.
Common interface for login logic of authentication requests.
Attempts to login the user with the given user name and password.
Represents the parsed parameters for the
FormPreviewImageServlet.A mail context that can send emails.
Interface for the factory for creating mail contexts
Deprecated.
use
IBaseMailData insteadDeprecated.
Use the new workflow engine (
IWorkflowEventRunner).Interface for mail-encryptors
Interface for certificate-providers for the mail-encryption
Mail server settings for sending mails.
Deprecated.
Interface for a scanner that can detect malware.
The result that is returned by a malware scan plugin.
Deprecated.
use
IClientCreatorSchnittstelle für Modelklassen, die in Beziehung zu einem Mandanten stehen.
Dieses Interface bildet eine Schnittstelle für Filter, die auf Mandantenabhängigkeit Prüfen.
Deprecated.
This is part of the old rest API.
Deprecated.
since version 8.0.0 Use
LDAPZugriff for client scoped LDAP connections instead.Deprecated.
since version 8.0.0 Use
LDAPZugriff for client scoped LDAP connections instead.Represents the different between two
Maps, i.e. when comparing two maps m1 and m2, which keys were removed,
which keys were added, and which values were changed.Represents a value that was changed, used by
IMapDiff.getModifiedEntries().A
IValueBuilder for creating a map value.A
IValueDescriptor for a map value.A
IValueDescriptorBuilder for creating a map value descriptor.Common interface for match conditions.
Deprecated.
Table no longer exists
Deprecated.
Table no longer exists
Factory for generating import config data
Wrapper class for
IEntityImportConfigs so additional information can be displayed.Same as the
p:importConstants tag, but extends it with an additional attribute loader.TagHandler for the ImportEnumMap component.Annotation for translating deprecated entities and entity fields to current fields
Common interface for the handler for accessing properties of the master server properties files.
Interface for a POJO view model class that describes a list of attachments that can be selected by the user.
Interface for a POJO view model class that describes a list of files that can be selected by the user.
A builder for an HTTP request multipart body (
multipart/form-data).Interface for a wrapper that provides a name for the named element.
Schnittstelle für benannte Elemente, die als Text angezeigt werden können.
Deprecated.
use
INamedUiElementCommon interface for all objects (mainly entities) that have got a name.
CDI-injectable provider for the inboxes available during workflow editing and validation.
Builder for
IInboxFormRecordRequestsFactory for creating default
IInboxFormRecordRequestsDeprecated.
Event for when an entity was modified, either when it was created, updated, or deleted.
Model for preferences of a
UserProfile regarding the form inbox.Helper methods for obtaining all tasks a user may initiate in the inbox.
Servlet for saving the submitted form data and triggering the workflow from the inbox.
Deprecated.
Belongs to the old workflow engine.
POJO model for JSON patches received from the form designer for the form persist JSON.
Indirect client authorizations define the permission to
Mandants using filters of a
SystemAuthenticator.API class for reading and writing
UserProfile entities.Implementation of the
IIndirectClientAuthorizationDao for reading and writing
IndirectClientAuthorization entities.Listener registrator for listeners of the
IndirectClientAuthorizationDaoHandler implementation for reading and writing
IndirectClientAuthorization entities.This factory creates general
indirect clients for IAuthenticators with sensible defaults that
can be used in various contexts.Contains the additional workflow element handlers that should be loaded when the flowchart is loaded.
JSON-convertible client POJO model for the node prototypes that should be set when a new task is created.
Default POJO implementation of
IInitialNodePrototypeModel.System update that sets the initial value of the 'deactivate content type verification for uploads' system property.
A
IWorkflowLocalHandlerValidationContext that can be injected via dependency injection.Interface for the parameters that are passed to
INodeHandler.execute(INodeExecutionParams).All node handlers must be thread-safe.
Interface for node prototypes, i.e. for nodes that can added to the flowchart via drag & drop.
The interface of a bean for editing the properties of workflow nodes.
Workaround for Java not having intersection types.
The data that is used to create a new node when a node prototype is dragged into the workflow designer.
A prototype for a workflow node that is shown in the drawer panel in the workflow designer.
View wrapper model for the elements drawer panel.
Builder for the exception thrown by a node when it wishes to stop the current execution by issuing a return
statement.
Builder for the exception thrown by a node when it encounters an error upon execution.
A reference to a workflow node, such as those returned by
IWorkflowProvider.getProvidingPredecessors(NodeKey).Represents the result of
INodeHandler#execute when the node was
executed normally, i.e. without throwing an exception or returning.Builder for the result returned by a node when it was executed successfully.
Bean for doing user credentials login for input clients.
Used by the PDF importer, data with the element to insert into the form.
Requests a livecycle file to get loaded in the workflow designer.
POJO response data for
InsertFormElementRequest.POJO model for inserting a node into the flowchart from external Java code.
POJO model for inserting a node into the flowchart from external Java code.
When a new action needs to be created in the workflow flowchart.
GSON type adapter for (de-)serializing interfaces marked with
ISerializableInterface.GSON type adapter factory for creating type adapters for interfaces.
Factory for creating
entity manager instances, configured according to the database settings of
the application.Authenticator for retrieving
UserProfiles by validating formcycle user credentials.A
IValueBuilder for creating a null value.A
IValueDescriptor for a null value.A
IValueDescriptorBuilder for creating a null value descriptor.Handlers for invalid credentials on AJAX authentication requests that return JSON content.
Exception when a name is encountered that cannot be used literally as a
URI path segment.Builder for the event data for a form record invitation error event, i.e. when an error occurred while trying to send
an invitation to a form record.
Builder for the event data for a form record invitation sent event, i.e. when a user sent an invitation to a form
record.
POJO Model for a workflow task / trigger that can be initiated by a user in the inbox.
Visitor callback for visiting the fields of an object via reflection.
Mixin that implements
IElementHandler.getHelpPageLocation(Locale) by returning a link to the official help
pages.Mixin for nodes that implements
IElementHandler.getHelpPageLocation(Locale) by returning a link to the
official help pages.Mixin for nodes that implements
IElementHandler.getHelpPageLocation(Locale) by returning a link to the
official help pages.Value that is returned by
ITriggerHandler.onTaskBegin(de.xima.fc.interfaces.workflow.params.ITriggerOnTaskBeginParams).Builder for
IOnTaskBeginRetVal.Interface that allows the ordering of classes using the
SequenceOrder annotaionCommon interface representing a user from a Pac4j
UserProfile.A builder for an HTTP request body that can have parameters, such as a multipart or form data body.
Interface für den Zugriff auf wesentliche Eigenschaften, sowie den Wert eines Parameter-Objektes
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Data about a placeholder parsed from its string representation.
A form field of a PDF AcroForm.
An AcroForm button that can be pressed.
A selectable option, either a check box or a radio button.
An AcroForm form field with a checkbox that can be enabled or disabled.
An AcroForm form field for selecting values from a list of options.
An AcroForm form field for selecting a value from a list of options.
An AcroForm form field for selecting one or more values from a list of options.
An AcroForm form field with a radio button that can be enabled or disabled.
An AcroForm form field for entering a signature.
An AcroForm free-text form field for entering plain text.
Represents a PDF document with pages.
Visitor with custom logic for
PdfFormProcessor.Represents an image included in the PDF, which could e.g. be used for illustrations or logos.
Represents a plain text line, cConsisting of multiple
words.A page of the the PDF.
Represents a piece of plain text in the image, used e.g. for form element labels.
Represents a plain text word, consising of multiple
IPdfText.Interface for escaping the replaced value of placeholders, before they are inserted into the document where they are
embedded.
A placeholder group for the
IPlaceholderLibrary, which allows for grouping placeholders.A list with all placeholders that are available.
Models a property of a workflow element's properties model that contains one or more placeholders.
Models a placeholder that is contained within a
IPlaceholderProperty.Represents a placeholder type by which the available placeholders are grouped when displayed.
Interface for placeholder params that implements all interfaces for the different placeholder types.
A plugin for adding custom
IPluginAccessPropertys to the formcycle backend.Parameters for plugin access-properties
Interface for a custom access property provided by an access property plugin, see
IPluginAccessProperty.Mixin meant for
IPluginWorkflowNode plugins that only wish to provide a workflow action that executes some
business logic.Common interface for plugins that provide a custom authentication logic.
Common interface giving details for plugin authenticator config GUIs
Common interface for requesting custom plugin config GUI details
Interface for the bean of a
IAuthenticator.Interface for custom authenticator types.
Interface for backend theme plugins.
Common interface for a custom callback logic that can be provided by a plugin.
Interface for client dashboard plugins.
Interface for the bean of a
IPluginClientDashboard.Mixin meant for
IPluginWorkflowNode plugins that only wish to provide a workflow condition that checks a
condition and redirects to the if or else branch based upon the result.Interface für Plugin-Konfigurations-Parameter
Definitionsmöglichkeiten für das Verhalten eines Plugin Parameters
Deprecated.
Use the new workflow engine, which lets you specify a custom model and a custom UI.
Deprecated.
Use the new workflow engine, e.g.
Deprecated.
Use the new workflow engine, e.g.
Interface for events that may occur after saving the plugin configuration definition
Interface for events that may occur during before deletion of plugin configuration definition
Interface for events that may occur during before saving plugin configuration definition
Interface for a data source plugin.
Interface that encapsulates the parameters for a data source plugin.
Interface for the return value of data source plugins.
A manager for
EntityManagers that can be used by an entities plugin.Interface for an entities plugin.
For use by an entities plugin.
Interface for entities plugins.
IPluginEntity<META extends IPluginFileEntity<?,?,?>,DATA extends IFileDataEntity<META>,CONFIG extends IFileDataEntity<META>>
A plugin entity, either scoped to a particular client or to the system.
IPluginFileEntity<E extends IPluginEntity<?,?,?>,J extends IFileDataEntity<?>,C extends IFileDataEntity<?>>
IPluginFormAuthenticatorParams<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Interface with the parameters passed to an authenticator type plugin when a new client needs to be created for a form
authentication context.
Deprecated.
Since version 8.0.0.
Interface for plugins to add additional resources (CSS or JavaScript) to the form designer.
Parameters that are passed to the form designer resource plugins.
Parameters that are passed to form designer resource plugins when retrieving the runtime data for the client-side
JavaScript.
Parameters for the form element catalog plugin (
IPluginFormElementCatalogue).Interface for plugins that may add a set of form items to the designer.
Parameters that are passed to the form element widget plugins when searching for JavaScript and CSS resources.
A plugin that lets you add additional properties to existing form elements, which can be configured in the form
designer.
Parameters for the plugin that lets you add additional properties to existing form elements.
Result returned by form element properties extension plugins.
Interface for plugins that wish to provide custom template for the form designer.
Descriptor for a form element template from a plugin.
An icon for a
IPluginFormElementTemplateDescriptor, consisting of a media type and a URI.Value returned by form element template plugins (
IPluginFormElementTemplateParams), with a list of
additional templates to be made available.Loader for the form element templates provided by a form element template plugin.
Parameters for the form element template plugin (
IPluginFormElementTemplate).Mixin that implements the methods of
IPluginFormElementTemplate with defaults for static form element
template plugins, when you have all templates stored as resources in the plugin's class path (i.e.Interface for plugins to integrate own form element widgets within the form designer.
Parameters that are passed to form element widget plugins when retrieving the runtime data for the client-side
JavaScript.
Parameters that are passed to a form element widget.
Interface for form pre-persist plugins.
Interface for the parameters of form pre-presist plugins.
Interface for the return value of form pre-persist plugins.
Interface for a form pre-process plugin.
Interface for the parameters of form pre-process plugins.
Interface for the return value of form pre-process plugins.
Interface for form pre-render plugins.
Interface that encapsulates the parameters for a form pre-render plugin.
Interface for the return value of form pre render plugins.
Interface for a form pre-respond plugin.
Interface for the parameters of form pre-respond plugins.
Interface for the return value of form pre-respond plugins.
Deprecated.
This plugin type was never called and will never have any function.
Deprecated.
The corresponding plugin type was never called and will never have any function.
Deprecated.
The corresponding plugin type was never called and will never have any function.
Plugins that allows the form render process to be customized.
Base parameters of callbacks invoked when a form is rendered.
Base parameters of callbacks invoked when an item is rendered.
Parameters of the callback invoked after rendering a form.
Return value of the callback invoked after rendering a form.
Parameters of the callback invoked after rendering an item.
Return value of the callback invoked after rendering an item.
Parameters of the callback invoked before rendering a form.
Return value of the callback invoked before rendering a form.
Parameters of the callback invoked before rendering an item.
Return value of the callback invoked before rendering an item.
Interface for a form replacer plugin.
Interface that encapsulates the parameters for a form replacer plugin.
Interface for the return value of a form replacer plugin.
Interface for plugins to integrate form resources like CSS or JavaScript
Parameters for the method of a form resource plugin that retrieves the data of the resource.
Interface for a generic plugin.
IPluginGenericAuthenticatorParams<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Interface with the parameters passed to an authenticator type plugin when a new client needs to be created for a
generic authentication context.
Interface for the return value of an authenticator type plugin, when used as an authenticator for a generic
authentication context.
Interface for plugins that provide a custom user interface.
Interface for a managed bean required by a plugin that provides a custom user interface.
Interface for the parameters of generic plugins.
Interface for common parameters of all placeholder replace plugins.
Base interface for the return values of placeholder plugins.
Interface for the return value of a generic plugin.
Represents the result when the properties of a plugin were validated.
The callback method that is invoked when the event occurred for which the listener was registered.
Common interface for a custom login logic that can be provided by a plugin.
Interface for plugins of type email encryption.
Parameters for plugin access-properties
Interface for the return value of an email encryption plugin.
Interface for plugins that add additional malware scanners to the system.
The manifest of a formcycle plugin.
Plugin for adding custom menu entries to the backend UI of formcycle.
Parameters for a menu entry plugin.
Enumeration of possible target types for a
IPluginMenuEntry.A plugin for checking the current status of the formcycle system via monitoring MBeans.
Interface für Plugin-Parameter
Plugin for creating custom portals with own ui
Deprecated.
You should use the new workflow engine.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Interface for the return value of a processing plugin.
Common interface representing an attribute for profile attribute filters used in user filters
(
IndirectClientAuthorization).Common interface for parameters for getting attribute options for profile attribute filters used in user filters
(
IndirectClientAuthorization).Common interface for parameters needed for evaluating the value of a
profile
attribute.Common interface for plugin profile filter extensions.
Common interface for getting the recommended match conditions for profile attribute filters used in user filters
(
IndirectClientAuthorization).Common interface representing a possible value for profile attribute filters used in user filters
(
IndirectClientAuthorization).Common interface for parameters for getting attribute values for profile attribute filter used in
client authorization filters.Common interface for parameters for getting attribute value options for profile attribute filter used in
client authorization filters.Plugin interface for providing custom menus for projects with a specified scope
Plugin interfaces for providing beans to custom project menus
Interface for plugins of the typ project template.
Common interface for the return value of a plugin.
This interface marks an
IFCPlugin to only be initialized in Client scope.This interface marks an
IFCPlugin to only be initialized in SYSTEM scope.Interface for plugins servlet action plugins.
Interface for the parameters of a servlet action plugin.
Interface for the return value of a servlet action plugin.
Interface for a system replacer plugin.
Interface for the parameters of a session replacer plugin.
Interface for the return value of a session replacer plugin.
Deprecated.
Mixin for
IPluginServletAction that provides a basic implementation for a servlet action that provides static
resources.Interface for a system replacer plugin.
Interface for the parameters of a system replace plugin.
Interface for the return value of a system replacer plugin.
Interface for a template replacer plugin.
Interface for the parameters of template placeholder replacer plugins.
Interface for the return value of a template replacer plugin.
Mixin meant for
IPluginWorkflowTrigger plugins that only wish to provide a workflow trigger that executes
some business logic.Parameters passed to the validation lifecycle method of plugins.
Interface for validation rule plugins.
Interface for plugin views.
Interface for workflow node plugins.
Interface for workflow trigger plugins.
Data access object for creating, updating, and deleting
Postfach entities.The Class PostfachHandler.
Deprecated.
This is part of the old rest API.
Parameters for the pre deserialization hook of fields
Interface to be used in conjunction with
PreRenderViewActionListener, to make it easier for a component to
listen to a PreRenderViewEvent.Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine, e.g.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).API for interacting with product build resources via PROMA (product manager).
API for interacting with product resources via PROMA (product manager).
Common interface describing a (user) profile attribute.
Data access object for creating, updating, and deleting
ProjectIdentityCheckData entities.The base
IWorkflowEventData for all event belonging to a project (but not a form record), such as when the
form is opened for the first time.Common interface representing context data needed for project scoped
IUriResolvers.Data access object for creating, updating, and deleting
ProjectTag entities.Interface für Projekt-Templates
Common interface models representing a project version
Schnittstelle für Modelklassen, die in Beziehung zu einem Projekt stehen.
Main entry point for the individual APIs for interacting with PROMA (product manager).
A response from PROMA with the main result value and some additional details such as the status code of the response.
Describes a property that is part of a value.
Interface for all workflow actions that create files when they are executed.
Deprecated.
This is part of the old workflow engine.
A specific type of
IPublicPromaInvocationContext intended UI handling code within the Java Server Faces
framework.A builder for a
IPublicAsyncWebSocketContext.A specific sub type of
IPublicPromaInvocationContext intended generic server-side actions that uses a native
HTTP client to send requests.A builder for a
IPublicNativeSyncContext.An invoker that is responsible for sending API calls to PROMA.
A
IPublicPromaCallInvoker that provides the result in an asynchronous, non-blocking fashion.A
IPublicPromaCallInvoker that provides the result in a synchronous, blocking fashion.Context that controls how the PROMA API is accessed.
A
IPublicPromaInvocationContext when the result is obtained asynchronously in a non-blocking manner.IPublicPromaInvocationContextBuilder<CONTEXT extends IPublicPromaInvocationContext,THIS extends IPublicPromaInvocationContextBuilder<CONTEXT,THIS>>
A builder for a generic
IPublicPromaInvocationContext.A
IPublicPromaInvocationContext when the result is obtained synchronously in a blocking manner.A specific type of
IPublicPromaInvocationContext intended UI handling code within the Java Server Faces
framework.A builder for a
IPublicSyncWebSocketContext.Specialized entity sorting criterion for sorting via QCM.
Common interface for detail information describing a quartz job
Query interface for getting entity references, passed to
IElementHandler.readEntityReferences(IReadEntityRefsParams).Models the parameters that are passed to
IElementHandler.readPlaceholders(IReadPlaceholdersParams).A member (property, key-value pair) of a record value as described by a
IRecordValueDescriptor.A
IValueDescriptor for a record value.A builder for a
IRecordValueDescriptor.Common interface representing an action to redirect.
Base interface for a POJO view model class, both for selecting a single attachment and for selecting multiple
attachments within the workflow.
Base interface for a POJO view model class, both for selecting a single file and for selecting multiple files within
the workflow.
Similar to the
IEventExecutionResult, but with slightly different info so that it can be sent to the frontend
server.Represents a form element that is repeated, by virtue of being repeated itself, and not by just being inside a
repeated container.
Extended
authorization context with parameters needed in IAuthorizers to check
the authorization of users to a web endpoint.Extended
availability context with parameters to check the availability of a web
endpoint.Represents the body of an HTTP request.
Builder for performing more than one cross scope conversation request and performing some logic when all have
finished.
Represents an individual resolved file, returned by
IWorkflowFileHandler.resolveReferencedAttachments(WorkflowNode, IReferencedAttachmentList, IAttachmentSearchOptions)Represents the result when resolving the attachments referenced by a single
AttachmentItem.Interface representing the resolved attachments as returned by
IWorkflowFileHandler.resolveReferencedAttachments(WorkflowNode, IReferencedAttachmentList, IAttachmentSearchOptions) resolveReferencedAttachments}.Handler for processing the results obtained when a list of referenced attachments was resolved, see
IResolvedAttachmentList.collectResult(IResolvedAttachmentListProcessor).Models the type of source from which an attachment from the workflow was obtained, together with the details of the
source, returned by
IWorkflowFileHandler.resolveReferencedAttachments(WorkflowNode, IReferencedAttachmentList, IAttachmentSearchOptions).A
IResolvedAttachmentSourceDetails for attachments created by a previously executed node.A
IResolvedAttachmentSourceDetails for files obtained via a search for attachment by file name and type.A
IResolvedAttachmentSourceDetails for an attachment obtained from an upload element, submitted as a file
upload by the user.Represents an individual resolved file, returned by
IWorkflowFileHandler.resolveReferencedFiles(WorkflowNode, IReferencedFileList, IFileSearchOptions)Interface representing the resolved files as returned by
resolveReferencedFiles.Handler for processing the results obtained when a list of referenced files was resolved, see
IResolvedFileList.collectResult(IResolvedFileListProcessor).A
IResolvedFileSourceDetails for files obtained from an attachment of the form record.A
IResolvedFileSourceDetails for a file from the client.Models the type of source where a file from the workflow was obtained from, together with the details of the source,
returned by
IWorkflowFileHandler.getFilesMulti(WorkflowNode, IMultiFileProviding, IFileSearchOptions) and
IWorkflowFileHandler.getFileSingle(WorkflowNode, ISingleFileProviding, IFileSearchOptions)A
IResolvedFileSourceDetails for a file from the current form.A
IResolvedFileSourceDetails for a file obtained from an upload element, submitted as a file upload by the
user.A
IResolvedFileSourceDetails for files obtained from an external URL.A
IResolvedFileSourceDetails for files created by a previously executed node.Deprecated.
Implementations of this interface are returned only by deprecated methods, use non-deprecated methods
instead, e.g.
Represents the result when resolving the files referenced by a single
ResourceItem.Interface for enforcing access control to a resource specified by a URI or URL.
Interface for locating resource bundle for a given locale.
A resource
consumer that closes an opened resource and may throw an exception in doing so.A resource descriptor that consists of an
URI serving as the identifier for the resource, and an
IResourceDescriptor.open() method for accessing the content of the resource.Helper interface for creating the resource descriptor for a workflow element (node or trigger) of a given
IWorkflowElementTypeProviding.getType().Deprecated.
This class is part of the old workflow engine and will be removed together with it soon.
Common interface for both the resolved file list and each resolved resource item, which both provide access to the
errors that occurred.
A function that opens a resource and may throw an exception in doing so.
Mixin for nodes that neither return a result nor do throw an error.
Parameters that are returned from to
IElementPropertiesBean.retrieveCurrentProperties(Object) when the
workflow element is stored or saved.Represents the result of
INodeHandler#execute when the node was
completed abruptly by issuing a return statement.Common interface for URI resolvers of
web enpoints that can be rewritten (by ocpsoft's URL
rewriting).Deprecated.
Common interface for rolling file appenders
Common interface for rollover actions of
IRollingFileAppenderCommon interface for rollover strategy of of rolling file appender configs.
Authorizer that allows anyone
Checks the client name of the profile
POJO implementation of
IIsAvailableParams.Common interface for
file items that have been scanned for malware.Provides basic convenience methods for working with search terms of workflow elements.
Common interface for the formcycle security config.
A
ISequentialUpdating that interprets the version string as a Semver and updates the properties model
according to the previous and current semantic version.A
ISemverUpdating for WorkflowNode handlers.A
ISemverUpdating for WorkflowTrigger handlers.Result with information regarding a mail sending operation, see e.g.
Information about a mail that was sent by
IMailContext.send(IBaseMailData, Mandant).ISequentialUpdating<TData,TElement extends IWorkflowElementEntity,TVersion extends Comparable<TVersion>>
Implements
ICustomParametersUpdateable.updateCustomParams(IUpdateCustomParametersParams) by running the transitions
(upgrades) between the previous and the current version.A
BiFunction that is also serializable.A
BiPredicate that is also serializable.A
Consumer that is also serializable.A
Function that is also serializable.Markup interface for model classes that may be serialized to JSON (using GSON and
InterfaceSerializerTypeAdapter).A
Predicate that is also serializable.A
Supplier that is also serializable.A
Supplier that is also serializable and can throw exceptions.A
Supplier that is also serializable and can throw exceptions.A
UnaryOperator that is also serializable.Common interface for GUI server models.
Common interfaces for accessing
servlet context information.Common interface for data needed by events that are triggered via a servlet
Common interface for result data that is returned after the execution of servlet events.
Interface for the HTTP response that is sent in response to a
HttpServletRequest.Event for
ConversationScoped beans that limit their conversation to a particular session.Handler for events of
ConversationScoped beans that limit their conversation to a particular session.Interface for a POJO view model class that describes a single attachment that can be selected by the user.
Mixin that extends
ISingleBaseActionNodePrototype for builtin node types.A mixin for all nodes that are
ISingleNodePrototype and additionally use a properties model that extends from
BaseActionProps.Mixin that extends
ISingleBaseTriggerPrototype for built-in trigger types.A mixin for all nodes that are
ISingleNodePrototype and additionally use a properties model that extends from
BaseConditionProps.A mixin for all triggers that are
ISingleTriggerPrototype and additionally use a properties model that
extends from BaseTriggerProps.Mixin that extends
ISingleNodePrototype for builtin node types.Mixin that extends
ISingleTriggerPrototype for built-in trigger types.Interface for POJOs with the parameters for
SingleConditionEvaluator.test(ISingleConditionData).Deprecated.
This is part of the old workflow engine.
Element handler mixin for cases when a handler only wishes to provide a single prototype.
Interface for a POJO view model class that describes a single file that can be selected by the user.
Mixin that implements
INodeHandler.getNodePrototypes(IGetNodePrototypesParams) for cases when a handler only
wishes to provide a single prototype.Mixin that implements
ITriggerHandler.getTriggerPrototypes(IGetTriggerPrototypesParams) for cases when a
handler only wishes to provide a single prototype.Interface for types whose instances provide a custom sort key that should be used when sorting a list of instances.
Mixin interface for triggers that are invoked only by an external event specifying the ID of the trigger.
Interface for
IWorkflowEventData that are triggered and target a specific trigger.A factory for creating new
StageChain instances with a particular configuration.Handler that can create the error code and error data for the standard attachment resolution error behavior, see also
StandardErrorAttachmentListProcessor.Handler that can create the error code and error data for the standard file resolution error behavior, see also
StandardErrorFileListProcessor.Markup interface for pac4j
Clients that provide a custom
state generator.Common interface for states.
Descriptor for a built-in, non-dynamic placeholder such as
[%$PROJECT_ID%].Deprecated.
This is part of the old workflow, use the new workflow engine.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
since 7.0.0
Common interface for referencing a
StatusDeprecated.
This is part of the old rest API.
Common interface for referencing a
Status via UUIDMarkup interface for view models of
StatussAPI for interacting with store item resources via PROMA (product manager).
API for interacting with stores via PROMA (product manager).
Mixin providing utility methods for storing values in a string map
A
IValueBuilder for creating a string value.A
IValueDescriptor for string value.A
IValueDescriptorBuilder for creating a string value descriptors.Builder for the result of a node when it was executed successfully.
Represents a successful result of
INodeHandler#execute, i.e. when
the node completes normally or abruptly by returning.Model for the
IKeyValueSummarizableElement mixin.A key value pair.
Models text for the the
ISummaryKeyValueModel that appears before or after the main table.Interface for scoped beans that should support a method for changing by an event bus triggered handler.
Handler for
SystemAuthenticator entities.Data access object for creating, updating, and deleting
SystemPlugin entities.Interfaces for system changes
The result of execution a
WorkflowTask, returned by the task runner when the task was not executed
successfully.The result of executing a
WorkflowTask, returned by the task runner when the task was executed successfully.The result of execution a
WorkflowTask, returned by the task runner when the task was executed successfully.Represents the result of analyzing a workflow task.
Base data with the result of analyzing a workflow task, without analysis operations.
Represents the result of running one or multiple tasks.
Interface for workflow elements that have got a UUID to identify the parent task.
A reference to a workflow trigger.
Common interfaces for representing template data
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Additional utilities for
Iterables not found in other libraries.Represents an item with an index.
Refactor handler for plain text resources.
A
Consumer that may throw a checked exception.A
Supplier that may throw a checked exception.A
Runnable that may throw a checked exception.A
Supplier that may throw a checked exception.Interface for
TabModels that provide additional entries to the top menu header.Basisschnittstelle für alle ID-basierten Modellklassen.
Interface for treating an item as a node in a tree-like structure.
Interface for accessing the children of tree nodes, together with the data associated with each tree node.
Represents the parameters for
ITriggerHandler.isAppliesToEvent(ITriggerAppliesToEventParams).Each trigger may provide a set of data that is made available via placeholders when the task is executed.
Represents the parameters for
ITriggerHandler.getFilterCriteriaForEvent(ITriggerFilterCriteriaForEventParams).All trigger handlers must be thread-safe.
Interface for trigger prototypes, i.e. for triggers in that can added to the flowchart via drag & drop.
Parameters passed to the callback method
ITriggerHandler.onTaskBegin(ITriggerOnTaskBeginParams).Parameters passed to the callback method
ITriggerHandler.onTaskFinish(ITriggerOnTaskFinishParams).Common interface for rolling file trigger policies
Represents the parameters for
ITriggerHandler.isPreconditionSatisfied(ITriggerPreconditionSatisfiedParams).The interface of a bean for editing the properties of workflow triggers.
Workaround for Java not having intersection types.
The data that is used to create a new trigger when a trigger prototype is dragged into the workflow designer.
A prototype for a workflow trigger that is shown in the drawer panel in the workflow designer.
View wrapper model for the elements drawer panel.
A reference to a workflow trigger.
A
IValueBuilder for creating a tuple value.A
IValueDescriptor for a tuple value.A
IValueDescriptorBuilder for creating a tuple value descriptor.Deprecated.
use
IUncacheableFileMarkup-Interface for files which shouldn´t be cached
Represents the event data of an error event that is triggered when an unhandled exception occurred during workflow
execution.
A
IValueBuilder for creating a union value.A
IValueDescriptor for a union value.A
IValueDescriptorBuilder for creating a union value descriptor.Interface describing the parameters that are passed to
ICustomParametersUpdateable.updateCustomParams(IUpdateCustomParametersParams).Performs an upgrade from a previous version to a newer version.
Interface for all workflow actions that require upload files to perform their job.
Common interface for URI adapters which can modify a given URI with additional
context
information.Common interface representing context data needed for
IUriResolvers.Common interface for URI resolvers of
IWebEndpoint.Body builder for appending request parameters to the URL of an HTTP request
Common interface representing a URL resource which may be used for e.g. redirection.
Common interface representing an authenticated user.
DAO for reading and writing
UserCredentials entities.Handler for
UserCredentials entitiesDeprecated.
Use the new workflow engine (
IWorkflowEventRunner).DAO for reading and writing
UserEmail entities.Handler for
UserEmail entitiesCommon interface for
user profile tasks that perform some action with a user email on a user
profile.Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Common interface for identifying users within authenticators
DAO for reading and writing
UserIdentity entities.Handler for
UserIdentity entitiesCommon interface for
user profile tasks that perform some action with a user identity on a
user profile.DAO for reading and writing
UserProfile entities.Handler for
UserProfile entitiesDAO for reading and writing
UserProfileMfa entities.Handler for
UserProfileMfa entitiesCommon interface for tasks that perform some action on a user profile and return a redirect action that the
initiating user should be redirected to.
Common interface for user reference resolvers that help with identification of users defined by their user
reference.
Interface für alle Entitäten, die eine UUID besitzen.
Interface for objects that have got a UUID identifying them.
Base interface for builders that can create a value of a certain type.
A consumer that is passed a value builder and may call its methods to adjust the value created by the builder.
Base class for all value descriptors that describe the shape of (mostly JSON-like) data.
IValueDescriptorBuilder<V,TBuilder extends IValueBuilder<V>,TDesc extends IValueDescriptor<V,TBuilder>>
Base interface for builders that create a
IValueDescriptor which imposes certain restrictions on the values
it allows.A function that takes a value descriptor factory and returns a value descriptor created via the methods of the passed
factory.
Factory for creating
IValueDescriptors.A predicate on an edge of a
ValueGraph.Interface for entities that provide custom parameters stored as a JSON string.
Common interface for all objects (mainly entities) that have got a version number.
Common interface for formcycle views
Deprecated.
since 8.0.0 Use
IView instead.mark-up-interface for virtual entities
A
IValueBuilder for creating a void value.A
IValueDescriptor for a void value.Interface creating SQL-Queries for datatables
Deprecated.
This is part of the old rest API.
Common interface for web app definitions (e.g.
Data access object for creating, updating, and deleting
IWebDavAccessDao entities.Common interface that defines formcycle web endpoints with basic definitions for availability and authorization
requirements.
Common interface for GUI models that represent a confirmation dialog within the welcome page
(
/WEB-INF/xfc/templates/welcome/welcome.xhtml).Interface for
Widget that wish to provide their client configuration as a class.Deprecated.
Interface for all executors for workflow actions.
Represents part of the result returned by a workflow node when executed, specifically the attachments that were
created by the node.
Interface for the bean validator that can be accessed during validation via
IWorkflowLocalHandlerValidationContext.getBeanValidator().IWorkflowElementDao<TElement extends IWorkflowElementEntity & de.xima.cmn.dao.interfaces.IEntity<Long>>
Base DAO for all workflow elements.
Interface for workflow elements that behave differently depending on their type.
IWorkflowElementRegistry<TEntity extends IWorkflowElementEntity,TElement extends IWorkflowElementTypeProviding,THandler extends IElementHandler<?,TEntity>,TPlugin extends IFCPlugin>
Registry for all workflow element handler.
Interface for workflow element that have got a type and behave differently depending on that type.
Represents the result of validating a single workflow node or trigger.
Simple builder for a
IWorkflowElementValidationResult.A workflow node together with its deserialized model.
Base interface for all workflow events for the new workflow engine.
The workflow event runner is similar to
IWorkflowTaskRunner.The
IBaseWorkflowExecutionContext for the new workflow engine operating on WorkflowNodes.Data related to the current workflow execution, such as the form record or the locale.
Interface for objects that wish to listen to the various stages of a workflow execution.
Callback that is called after the workflow was executed, but before the final result is created.
Handler for running other nodes during the execution of a task, or triggering events.
Handler with utility methods for working with files during the execution of a workflow, and making these files
available to other workflow node.
Represents part of the result returned by a workflow node when executed, specifically the files that may be returned
by the node.
Interface for querying info about the control and data flow of a workflow process.
Handler with utility methods for working with the form and form records during the execution of a workflow.
Validation context that is passed to
IElementHandler.validateGlobal(de.xima.fc.interfaces.workflow.params.IElementGlobalValidationParams).Interface for all global validators of workflow elements.
API Handler for interacting and initializing the workflow for a form record.
Common methods for validation contexts used by node handlers.
A handler for interacting with the current HTTP request within the context of a workflow execution.
Validation context that can be used (such as by being
injected into an IChoiceProviding set on
a SingleChoice constraint annotation) during Jakarta bean API validation.Validation context that is passed to
IElementHandler.validateLocal(de.xima.fc.interfaces.workflow.params.IElementLocalValidationParams).Context holding data required during a local workflow validation process, i.e. when each node gets validated
individually.
Interface for all local validators of workflow elements.
Handler with utility methods for creating protocol entries when a node is executed.
Data access object for creating, updating, and deleting
WorkflowNode entities.Can perform an analysis of how a workflow task is executed, such as solving data flow equations for certain problems.
Handler for
WorkflowNode entities.Handler for locating nodes when a task is executed.
A
IWorkflowElementRegistry for WorkflowNodes.Represents the result obtained when a workflow node was executed.
Data access object for creating, updating, and deleting
WorkflowNodeSearchTerm entities.Marks the object as marking a certain workflow node type.
Interface for the workflow placeholder handler that lets you replace placeholders in strings easily.
Data access object for creating, updating, and deleting
WorkflowProcess entities.Deprecated.
Use the new workflow engine.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).A provider for the workflow designer that lets you access various data related to the workflow, such a list of all
user groups or text templates.
Represents a submit button of the form.
Instance passed to
IWorkflowTaskRunner.Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Parameters that are passed to
IWorkflowTaskRunner.runTasksForEvent(IWorkflowRunTasksForEventParams).Data access object for creating, updating, and deleting
WorkflowStateAuthenticatorConfig entities.Data access object for creating, updating, and deleting
WorkflowState entities.Handler for
WorkflowState entities.Markup interface for view models of
WorkflowStatesRepresents a submit button of the form.
Data access object for creating, updating, and deleting
WorkflowTask entities.Handler for
WorkflowTask entities.Handler for locating tasks when the workflow of a process is executed.
Starts the workflow for a given
WorkflowTask of a project.Data required for executing a workflow task, such as the client, user, and locale.
Data access object for creating, updating, and deleting
WorkflowTrigger entities.Handler for
WorkflowTrigger entities.Interface for quartz job info for quartz triggers for workflow triggers of the new workflow.
Data access object for creating, updating, and deleting
WorkflowTriggerSearchTerm entities.Marks the object as marking a certain workflow trigger type.
Context holding global data required during a workflow validation process.
General parameters for workflow related methods, such as the project containing the workflow and the client owning
the project.
Represents a message that is returned as the result of
IElementHandler.validateLocal(IElementLocalValidationParams).Describes the result of a workflow validation process, as produced by
WorkflowValidator.An object for validating the entire workflow of a project, or just parts of it (single tasks, triggers, or nodes).
Interface for the variable handler used during execution of the workflow.
Data access object for creating, updating, and deleting
WorkflowVersionBackup entities.Data access object for creating, updating, and deleting
WorkflowVersion entities.Handler for
WorkflowVersion entities.Query interface for providing information for updating entity references, passed to
IElementHandler.writeEntityReferences(IWriteEntityRefsParams).Models the parameters that are passed to
IElementHandler.writePlaceholders(IWritePlaceholdersParams).Base interface with common methods for both
IXValidationParams and IXGlobalValidationParams.Interface that may be implemented by an
XItem, usually by custom widgets that extend XSelect.Deprecated.
Interface for
IWorkflowEventData that contains an IXForm.Handler for form render callbacks.
Interface for
IWorkflowEventData that contains an IXFormRenderConfig.Interface for context that exists during the render of the form.
Interface for the parameters passed to the
IXItemBasic.validateGlobal(IXGlobalValidationParams) method.The base interface for all built-in form items and all widgets provided by plugins.
Describes the naming conventions for the form fields used by this type of form item.
Interface for widget plugins.
Interface for the parameters passed to the
IXItemBasic.processUpload(IXProcessUploadParams) method.Interface for the result returned by the
IXItemBasic.processUpload(IXProcessUploadParams) method.Represents a file uploaded when a form was submitted.
Interface for the parameters passed to the
IXItemBasic.validate(IXValidationParams) method.Represents the result of validating an
IXItem.Marker interface that should be implemented by all form element item handler classes that represent form elements for
which the user can enter and submit values, e.g. for input fields, select fields, checkboxes etc.
Dieses Interface bildet eine Schnittstelle für Filter, die auf Zugriffsrechte Prüfen.
Implementation of a
ICluster that uses EClusterImplementation.JGROUPS.Implementation of a
IClusterConnection that uses EClusterImplementation.JGROUPS.Implementation of a JGroups
Log that logs messages via sl4j.Implementation of a
CustomLogFactory that creates sl4j loggers.Factory for creating a job key for formcycle specific jobs.
Enumeration of the predefined job groups
Deprecated.
Represents the result of a JSF validation phase.
Responder-Implementierungen für JSON zur Request-Verarbeitung und/oder Response-Befüllung.
Helper for working with JSON patches according to as specified by https://tools.ietf.org/html/rfc6902.
Simple builder for a JSON path.
Converts objects to a Map of JSON path value pairs and back.
Helper class for working with JSON objects and JSON path.
Übergebenen JSON-Daten vom Typ JSONObject in Liste von ValueDescriptoren umwandeln
Checks whether a string matches a JavaScript regexp.
Generic servlet for keeping a session alive
Bean that keeps the session alive, for use with the composite component
xi:keepSessionAlivePollDeprecated.
Deprecated.
Will be moved in version 8.0.0.
Deprecated.
Use
ClientFactory or IndirectKerberosClient instead.Bean zum Abspeichern / Laden der NTLM-Konfiguration.
System update that migrates the
user filer for LDAP user search to
the kerberos.properties.Wrapper for authenticator configs of type
EAuthClientType.KERBEROSKerberosExtensionAuthenticatorProperties<TAuthenticator extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for the properties of an authenticator of type
EAuthClientType.KERBEROS_EXTENSION.Service that retrieves the profile data from an LDAP connection.
A validator the check the Kerberos ticket.
Deprecated.
Use
KerberosTicketValidatorImpl instead.Deprecated.
Use
IUser or default UserProfile instead.An email-encryptor key-provider to determine the certificates by a keystore.
How to handle labels for bean validation.
Use a custom label.
Include the default label, see
Label.Do not include the label, see
Label.Mostly dummy
IXFormRenderConfig that only implements LanguageFd2Config.getLanguageProvider().Wrapper for reading a string lazily, e.g. from a file.
Lazy schedule model for the inbox appointment view.
Allows rendering its children dynamically after page load and enables partial update renders.
Property keys for state saving of
LazyContainer.Default renderer for
LazyContainer.Custom data model for lazily loading project view models
Deprecated.
A tree node for a lazy loading PrimeFaces trees.
API class for manipulation of
LDAPAbfrage entities.LdapAuthenticatorProperties<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for the properties of an authenticator of type
EAuthClientType.LDAP.Deprecated.
Deprecated.
Bean für die Verwaltung von Verbindungen
CDI-injectable provider for the LDAP connections available in the current client during workflow editing and
validation.
Factory for creating LDAP connections for authentication clients.
Event for when an entity was modified, either when it was created, updated, or deleted.
Model for client authorizations of type
EAuthClientType.LDAPDeprecated.
Deprecated.
Since Version 8.0.0 user information is stored
UserProfiles.Deprecated.
Since Version 8.0.0 user information is stored
UserProfiles.Deprecated.
Since Version 8.0.0 LDAP access to
Mandants is stored in IndirectClientAuthorizations.Bean für die aktuelle Session und deren Informationen
Provider for the LDAP queries available in the current client during workflow editing and validation.
Event for when an entity was modified, either when it was created, updated, or deleted.
API class for mainpulation of
LDAPZugriff entites.Helper class for creating legacy export of projects
Model that combines a system and a client license.
Deprecated.
This entity represents licenses.
API class for mainpulation of
LicenseFile entites.Deprecated.
Use
LicenseAccess insteadModel to access an license based on there file-data
Servlet for notifying a client license update to trigger a download
Utility class for reading data from and writing data to the product management server via HTTP requests.
Factory for creating an liquibase context
Implements
IResourceAccessControl with a blacklist and whitelist.Simple builder for configuring a
ListedResourceAccessControl instance.A
IUpdateTransition composed of multiple individual .transitions.Deprecated.
The
loader attribute is now available in recent releases of OmniFaces.Requests a form persist JSON to get loaded in the workflow designer.
Requests a livecycle file to get loaded in the workflow designer.
Requests a PDF file to get loaded in the workflow designer.
Requests a workflow persist to get loaded in the workflow designer.
Deprecated.
This is called
LocalDateTimeConverter, but behaves as if it were a LocalTimeConverter.Bean des aktuellen
LocalesA set of named variables that can grow over time.
A set of one local variables.
A set of two local variables.
A set of three local variables.
A set of four local variables.
A set of five local variables.
A set of six local variables.
A set of seven local variables.
A set of eight local variables.
A set of nine local variables.
Helper-Class for the configuration of loggers and appenders
Bean for configuring loggers & appenders
An implementation of
HttpRequestInterceptor interface for logging request information.An implementation of
HttpResponseInterceptor interface for logging request information.Helper for storing / removing user login attempts and checking the user login state.
Deprecated.
Use
LoginAttemptHelper instead.Deprecated.
Use
ELoginState instead.Deprecated.
since 8.0.0 System user login is done via
UserCredentialsSigninBean.Cache storing user login attempts.
Deprecated.
Use
LoginCache instead.Deprecated.
Bean providing information for various login screens
Deprecated.
since version 8.0.0 login events are no longer fired.
Deprecated.
Since version 8.0.0 login is done via
ILoginLogic or ISecurityConfig.Bean for accessing the backend login layout configuration.
Bean for configuring the backend login layout.
Modelklasse für den Login
Deprecated.
This servlet is only used for signing in for the legacy "REST"-API.
Represents the URL to which the user is redirected when the click on the formcycle or FORM.CLOUD logo at the top
left.
Deprecated.
API class for sending of system mails.
Utility class for archiving mail.
Represents the configuration settings for a mail server for validating the correct configuration of the selected
authentication.
Bean für die Konfiguration eines Systemweiten E-Mail Servers
Factory for creating an mail context
Deprecated.
Exception thrown when an email cannot be send because no mail context (=mail server configuration) is available.
Provider for managing informations an contexts for mail server
Factory for creating an mail-encryptor by a given type
The Class MailHandler.
Utility class for sending mail.
Common mail utils.
View scoped bean holding the main menu of the adminstration backend.
Builder for main menu entries.
Generic exception that is thrown when a file or some data was detected to contain malware.
Utility class that scans files and data for malware.
Helper for malware scanning.
Represents the result of a malware scan.
Diese Entität bildet einen Mandanten ab.
API class for manipulation of
Mandant entities.Deprecated.
This is part of the old rest API.
Deprecated.
Use
LDAPZugriff instead.Deprecated.
since version 8.0.0 Use
LDAPZugriff for client scoped LDAP connections instead.Deprecated.
since version 8.0.0 Use
LDAPZugriff for client scoped LDAP connections instead.Deprecated.
since version 8.0.0 Use
LDAPZugriff for client scoped LDAP connections instead.The default implementation of
IMandantRessourceDao that can be accessed via DaoProvider.Deprecated.
This is part of the old rest API.
Extends the
RandomAccessFileInputStream to provide support for MarkableRandomAccessFileInputStream.mark and MarkableRandomAccessFileInputStream.reset().Constraint validation that may be applied to
TimeDuration.Defines several
MaxTimeDuration constraints on the same element.Validator implementation for the
MaxTimeDuration constraint.Deprecated.
Deprecated.
Use
MainMenuBean instead.Deprecated.
The
MenuTemplateBean has been deprecated.Bean providing utility methods for working with messages.
Helper JSF component that can be used to listen to faces messages.
Event that is triggered when messages are added to a
MessageListener.Parameters for the
MessageListener.getTransform() callback.Handler class for
MessageListener, registers the appropriate functions.Default renderer for
MessageListener.Parameters for the
MessageListener.getTransform() callback.Deprecated.
This is part of the legacy REST API that will be removed at some point.
Filter that checks user profile for possibly multi factor authentication and initiates it if required.
Creates LDAP connections for all
MandantLdapData and connects them with appropriate LDAP queries or actions.Deprecated.
Before version 8.0.4, references to user groups in the form designer used the name of the user group.
Migrates all users to user profiles and creates client authorizations
Migrates all user references in workflow actions to references to the new
DirectClientAuthorization.Helper for working with formcycle sessions
Utility class for migrating project properties
Constraint validation that may be applied to
TimeDuration.Defines several
MinTimeDuration constraints on the same element.Validator implementation for the
MinTimeDuration constraint.A special
IOException thrown when the actual checksum (e.g.Builder for mock form requests that can be used in unit tests.
Event for the
Flowchart component, when the process model was updated.Deprecated.
Table no longer exists
Deprecated.
Moduls no longer exist.
Deprecated.
Table no longer exists
Deprecated.
Table no longer exists
A servlet context listener for the formcycle master server.
Builder for creating
Microsoft Graph service clients.Logger that logs MS Graph API messages.
Deprecated.
Use
MsGraphLogger instead.Mail context for sending MIME mails via the ms graph api
Profile creator for Azure AD logins using the OAuth 2.0 access token and the MS Graph API.
Deprecated.
Use
MsGraphProfileCreator instead.Implementation of
IHandlerProvider for the master server.API for accessing properties of the properties file on the master server.
Default implementation of the
IMsPropertiesHandler interface.Class for setting up the master server security.
Deprecated.
Helper class for accessing MS system properties.
Models a list of attachments that may come from multiple sources, such as uploads, creates by another action, or with
a specific name.
Custom label for the
MultiAttachment.getAttachments() property.Custom label for the
MultiAttachment.getSearchFilenamePattern() property.Constraint validation that may be applied to
MultiAttachment.Defines several
MultiAttachmentSize constraints on the same element.Check which of the given
MultiAttachmentSizeGroup.fields() of the annotated element are in compliance with the
MultiAttachmentSize constraint.Defines several
MultiAttachmentSizeIf constraints on the same element.Constraint annotation validator for
MultiAttachmentSizeGroup.Class-level constraint annotation that checks enforces another constraint to a field of the class only when a
condition that may depend on other fields of the class is satisfied.
Defines several
MultiAttachmentSizeIf constraints on the same element.Constraint annotation validator for
MultiAttachmentSizeIf.Constraint annotation validator for
MultiAttachmentSize.Class for handling multi-factor authentication
Models a list of file resources that may come from multiple sources, such as client file, project files or external
files referenced via an URL.
Custom label for the
MultiFile.getResources() property.Custom label for the
MultiFile.getSearchFilename() property.Custom label for the
MultiFile.getUrls() property.Constraint validation that may be applied to
MultiFile.Defines several
MultiFileSize constraints on the same element.Check which of the given
MultiFileSizeGroup.fields() of the annotated element are in compliance with the MultiFileSize
constraint.Defines several
MultiFileSizeIf constraints on the same element.Constraint annotation validator for
MultiFileSizeGroup.Class-level constraint annotation that checks enforces another constraint to a field of the class only when a
condition that may depend on other fields of the class is satisfied.
Defines several
MultiFileSizeIf constraints on the same element.Constraint annotation validator for
MultiFileSizeIf.Constraint annotation validator for
MultiFileSize.Deprecated.
use
MultipartMailData insteadText email data with attached Files
Filter that wraps
multipart requests in a special request wrapper that allows for accessing of the
request parts multiple times during the request scope and performs unified malware scanning for all uploaded files.A wrapper for
multipart HttpServletRequests that preserve their mulitpart parts,
meaning the parts can be accessed multiple times during the entire request scope and performs immediate malware
scanning upon parts parsing.Deprecated.
Deprecated.
Implement
ICompoundConditionData yourself, or just pass the single arguments to
CompoundConditionEvaluator.test(EMultipleConditionCombinationType, String, Map).Comparator-Implementierung für den Vergleich von
INamedUiElement-Instanzen.NameMatcher<T extends org.quartz.utils.Key<?>>
Matches on name (ignores group) property of Keys.
Klasse zum Sortieren von Plugins anhand des
INameProviding.getName()Deprecated.
since 8.0.0
Exception for missing credentials on a user profile.
An event that is fired when it is suspected that the connection to a node in the cluster may have been lost.
Event for the
Flowchart component, when a node was expanded or collapsed.An event that is fired when a node joined the cluster.
The key of a workflow node that uniquely identifies it within the context of a process.
An event that is fired when a node left the cluster.
An event that is fired when a message was sent by a node to other nodes.
Models a node that is part of a cluster.
View model corresponding to the WorkflowNode entity, used by the
Flowchart component.Default POJO model for
INodeModelPrototype.Bean that controls the properties panel when a
NodeModel is selected.Default POJO implementation of
INodePrototypeData.Default POJO implementation of
INodePrototypeDescriptor.A builder for a
INodePrototypeDescriptor.View wrapper model for the elements drawer panel.
Indicates that an exception occurred during the execution of a workflow node.
A simple builder for configuring a
NodeReturnedException.Indicates that a soft error occurred during the execution of a workflow node.
Provider for workflow nodes that makes available all nodes in the entire workflow process that are of a given
type.Indicates that execution of a workflow node ended abruptly via a throw statement, including exceptions thrown by the
workflow runtime engine.
A simple builder for configuring a
NodeThrewException.POJO implementation of
INodeWithName.Annotation for marking fields to be not encrypted during JSON path serialization by
JsonPathMapConverter.Constraint validation that may be applied to
SingleAttachment.Defines several
NonEmptySingleAttachment constraints on the same element.Check which of the given
NonEmptySingleAttachmentGroup.fields() of the annotated element are in compliance with the
NonEmptySingleAttachment constraint.Defines several
NonEmptySingleAttachmentIf constraints on the same element.Constraint annotation validator for
NonEmptySingleAttachmentGroup.Class-level constraint annotation that checks enforces another constraint to a field of the class only when a
condition that may depend on other fields of the class is satisfied.
Defines several
NonEmptySingleAttachmentIf constraints on the same element.Constraint annotation validator for
NonEmptySingleAttachmentIf.Constraint annotation validator for
SingleAttachment.Constraint validation that may be applied to
SingleFile.Defines several
NonEmptySingleFile constraints on the same element.Check which of the given
NonEmptySingleFileGroup.fields() of the annotated element are in compliance with the
NonEmptySingleFile constraint.Defines several
NonEmptySingleFileIf constraints on the same element.Constraint annotation validator for
NonEmptySingleFileGroup.Class-level constraint annotation that checks enforces another constraint to a field of the class only when a
condition that may depend on other fields of the class is satisfied.
Defines several
NonEmptySingleFileIf constraints on the same element.Constraint annotation validator for
NonEmptySingleFileIf.Constraint annotation validator for
SingleFile.POJO implementation of
INormalCompletionResult.A simple builder for an
NormalCompletionResultDefault implementation of
INormalCompletionResultBuilder used by the task runner.When a resource or page could not be found.
Bean that stores all faces messages that should be redisplayed in the notification history to the top right.
Deprecated.
Deprecated.
NTLM is no longer supported by Micrsosft.
Cache for NTLM related settings, such as the available challenge managers.
Deprecated.
A client to authenticate an user by NTLM
Bean zum Abspeichern / Laden der NTLM-Konfiguration.
Deprecated.
since version 8.0.0 NTLM is no longer supported officially.
Credentials containging the username after the NTLM login
Extractor to get the NTLM credentials with
Deprecated.
Deprecated.
Use default
UserProfile instead.Custom
UserType for non-nullable UUIDs.Deprecated.
Depending on the use case the appropriate profile creator should be used, e.g.
OAuth20Wrapper<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Deprecated.
Use
OAuth2AuthenticatorProperties instead.OAuth2AuthenticatorProperties<TAuthenticator extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for accessing the properties of an authenticator of type
EAuthClientType.GENERIC_OAUTH2 in a
structured manner.A scanner for visiting each instance field of an object via reflection.
OIDCWrapper<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Deprecated.
Use
OpenIdConnectAuthenticatorProperties instead.Handles designer conversation events that are relevant to the old workflow designer tab.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Can be removed once the old workflow is removed.
OpenIdConnectAuthenticatorProperties<TAuthenticator extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for accessing the properties of an authenticator of type
EAuthClientType.GENERIC_OPENIDCONNECT in
a structured manner.Requests a livecycle file to get loaded in the workflow designer.
POJO response data for
OpenPdfInlineViaSessionKeyRequest.Common helper class for working with pac4j.
Utility class for working with
pac4j.Bean with methods for the
parameterList composite component.Model für das Handling von Parametern, welche dann als JSON-Objekte ablegt werden
Request-Parameter-Wrapper
For normal form elements, the name as submitted in the HTTP request is the same as the name that was configured in
the Designer.
PartialRenderListener<T extends javax.faces.component.UIComponent>
Must be registered for a
PreRenderViewEvent.Authenticator for checking a given password against password credentials.
Deprecated.
Use
PasswordAuthenticator instead.Authorizer for checking a given password against an authorization config
Deprecated.
Use
ClientFactory and appropriate IClientDescriptor instead.View model for custom authenticator config of type
EAuthClientType.PASSWORDWrapper for authenticator configs of type
EAuthClientType.PASSWORDCredentials consisting of a single password.
Deprecated.
Use
PasswordCredentials instead.Extractor for retrieving an password from an request
Deprecated.
USe
PasswordCredentialsExtractor instead.Mail context for sending mail via SMTP with user authentication
Bean for display user credential hints.
Deprecated.
Password policy change event aren't necessary anymore because the new PasswordPolicyBean is view scoped.
Deprecated.
PasswordPolicyChangeEvent is not necessary anymore.Deprecated.
Use
CommonProfile instead.Model class for serialising the data of an attempt to send an email to reset a user's password.
Helper for storing / removing user password reset attempts and checking the state for resetting the user password.
Cache storing password reset attempts.
Zentrale Behandlung von Pfaden (Dateisystem und URLs).
Zentrale Behandlung von Pfaden im lokalen FileSystem
Zentrale Behandlung von Formcycle-URLs
Implements
IResourceDescriptor by reading data from a file.Helper methods for loading a
PDDocument.Deprecated.
use
PDFFillerHelper class to flatten a PDF document.
Utility for processing the a PDF document as a form.
Controller bean for the PDF form importer.
Handles designer conversation events that are relevant to the PDF importer.
When one or more items were deleted in the designer that were originally imported from a PDF document.
An ongoing PDF import process session.
PrimeFaces dynamic resources (
DynamicContentSrcBuilder) use the Faces resource servlet, which does not
support view scoped beans.Helper class for creating images from individual pages of a PDF document or of thee entire PDF document.
Deprecated.
Deprecated.
Deprecated.
Generates the roles and permissions for the profile.
Deprecated.
Checks if the input of the form element is empty.
Replace a substring with another string.
Informational annotation that may be placed on a field to indicate whether the field's value may contain formcycle
placeholders, such as
[%tf1%].Utility class for creating a
PlaceHolder.API helper class.
This bean provides a list of available placeholders for an input field.
Event data used to indicate that some state has changed that may result in different placeholder being shown.
Model for the
PlaceholderBean.Caches the list of available placeholders for the duration of the active request.
A simple builder for creating a
IParsedPlaceholder POJO.Event handler registered by the
PlaceholderBean for the designer conversation scope.Implementation of a
IPlaceholderGroup with a single ID.The Class PlaceholderHandler.
Represents the set of placeholders available for selection in the placeholder dialog.
Event data that may be used when the a different set of groups of placeholders should be shown in the placeholder
dialog.
Event data that may be used when the registered placeholders should be changed or modified.
Event data that may be used when the selected project for the placeholder dialog has changed.
Class to replace placeholders
A converter for a list of Strings that respects placeholders.
Helper for splitting strings containing placeholders into the surrounding text and the placeholders.
Represents a non-placeholder part of a string.
Represents a placeholder part of a string.
Represents either a literal (non-placeholder) or placeholder part of a string.
This event changes the active placeholder groups by adding and removing the given groups.
This event changes the registered placeholders of a certain group by adding and removing the given placeholders.
Plugin-Action-Servlet
PluginAuthenticatorProperties<TAuthenticator extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Model class for accessing the properties of an authenticator of type
EAuthClientType.PLUGIN in a structured
manner.Default implementation for the return value of a
IPluginAuthenticatorType.buildFormAuthClient(IPluginFormAuthenticatorParams).PluginBeanHelper<TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>>
Helper class for handling unmanaged beans used by user interfaces provided by a plugin, eg. a dashboard plugin or a
workflow action plugin:
Interface for a callback before a bean is initialized.
Options for the
PluginBeanHelper.Simple builder class for a
PluginBeanOptions.An mail-encryptor key-provider to determine the certificates by browsing through Plugins
Model for the change log of a certain plugin version, consists of a version and the HTML string.
This class is for caching the information about plugin changes of a plugin version.
Referenz Implementierung für die
IPluginConfigParam - SchnittstelleThis class is for storing informations and data about dependencies of an plugin for displaying it at the plugin ui.
This is a model class for storing the informations to show in the delete/deactivate dialog of an plugin.
A manager for an
EntityManager that can be used by a plugin of type IPluginEntities.A simple implementation of
IPluginEntitiesConnectionRetVal you may use in a plugin.Implementation of the
IPluginEntitiesParams.An entity context for use by an entities plugin.
Utility class with some static methods for executing plugins related to the lifecycle of forms.
This class is for storing data of a plugin file with a file key.
PluginFormAuthenticatorParams<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Simple POJO implementation of
IPluginFormPreRespondParams.Default POJO implementation of
IPluginFormResourceGetDataParamsPluginGenericAuthenticatorParams<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Default POJO implementation of
IPluginGenericAuthenticatorParams.Default implementation for the return value of a
IPluginAuthenticatorType.buildGenericAuthClient(IPluginGenericAuthenticatorParams).Default POJO implementation of
IPluginFormReplacerRetVal, IPluginSessionReplacerRetVal,
IPluginSystemReplacerRetVal, IPluginTemplateReplacerRetVal.Groups all plugins with the same plugin key.
Model for the ID of a plugin.
When a plugin installed or updated.
Model for an unpacked plugin with some meta data from the manifest.
Manages the events listeners for the portal runtime.
Data class that holds the data for the
IPluginMailEncryptionParams that are passed to the plugin method.A POJO data class that for the return value of the mail encryption plugin.
Class for managing plugins
Model for plugin views.
A target plugin that is to be updated.
Monitoring Manager (Singleton) für Plugin - MBeans
Klasse zum Sortieren von Plugins anhand des
IFCPlugin.getName()This model class holds data after the user has confirmed that a plugin should be overwritten by a manually uploaded
plugin jar file.
A simple implementation of a
PersistenceUnitInfo, intended for entities plugin.Deprecated.
The corresponding plugin type was never called and will never have any function.
Deprecated.
Model representing a profile filter attribute.
Model-class for a registered plugin
Interface allowing access to plugin functionality within the
fc-security package.POJO implementation of
IPluginServletActionRetVal.Beans for the plugin store UI.
Model for a single store items that is shown in the plugin store.
A builder for configuring a
PluginStoreItem instanceModel for a tag of a plugin store item, consisting of a name and a color.
Loads the model for the plugin store from the remote repository.
Model for the plugin store that can be opened via the plugin menu page.
Represents the result of an entire plugin update operation, which may have updated many plugins from different system
and client scopes.
POJO for that groups all plugin form element templates from a single plugin, used by
FormTemplateHelper.fetchTagsAndTemplates(Mandant, Locale, IUser, Projekt, FormVersion).Utility methods for performing database-related operations of client or system plugins.
POJO with the result of an attempt to check for updates of a plugin.
This class is used to cache the plugin update message JSON data from the database for processing for the user
interface of the internal messages
This class is for caching the plugin information from PROMA for the plugin management interface.
POJO with the result of an attempt to update a plugin.
PluginWrapper<T extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>>
Deprecated.
Use
PluginAuthenticatorProperties instead.Helper functions for working with ZIPs containing a list of formcycle plugins.
Enumeration with the possible relationships between a range and a point.
POJO implementation of
IWorkflowValidationEnvironmentData.POJO implementation of
IWorkflowValidationEnvironmentData.Deprecated.
Base class for a
IDaoActionListener that delays the handler until after the transaction was committed.Diese Entität stellt ein Postfach dar.
API class for manipulation of
Postfach entities.The default implementation of
IPostfachDao that can be accessed via DaoProvider.The Class PostfachHandler.
Diese Klasse dient dazu Postfächer auszuliefern, hierzu ist die Klasses als Singleton konszipiert.
Deprecated.
This is part of the old rest API.
When form record validation failed after the form record was persisted.
Deprecated.
use
HttpPostRequestBuilder insteadDeprecated.
Deprecated.
Deprecated.
use
HttpPostRequestBuilder with HttpResponseWrapper instead.Base class for a
IDaoActionListener that delays the handler until just before the transaction is committed.Default implementation of a
ITriggerPreconditionSatisfiedParams.Utility for
Predicates.POJO model for the state of the form preview within the designer.
Parameters for the preview remote command, see
FormRenderHelper and DesignerPreviewPageBean.Builder to build
PreviewParams.Model holding the data submitted to the form preview servlet.
VirusScanner service implementation that delegates to the MalwareScanner.Klasse zum halten aller nötigen Informationen zum Drucken eines Formulares
Klasse zum verwalten von Druck-Aufträgen
Servlet Filter implementation class ExternalFilter
Vorgehensweise beim Kopieren eines Vorganges:
Bean providing export files for selected processes
Bean for the dialog where the user may select a workflow task to initiate and whether the current form data should be
saved.
Model that holds information necessary for displaying a process
Deprecated.
Deprecated.
Use the new workflow engine.
Deprecated.
Deprecated.
This is part of the old deprecated workflow engine.
Deprecated.
This is part of the old workflow engine, use the new workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Updates the processing of actions for use with new interfaces methods.
Updating processing parameters for FC version 6.2.0.
Deprecated.
This is part of the old deprecated workflow engine.
Deprecated.
This is part of the old workflow engine.
Factory for creating processing wrapper for actions
Bean for the process list view, either the standard inbox view or the form-specific inbox view.
A builder which creates a new instance of
Document, that displays a List of
ProtocolEntryProcessing entities in a tabular form.Exportor for creating Documents based on
ProtocolEntryProcessing entities.View model corresponding to the WorkflowProcess entity, used by the
Flowchart component.POJO with the data required for adding a processing protocol entry.
Bean for displaying the sent DOI email & possibly re-sending it
Bean for managing the different process listing views.
A single condition for
ProfileAttributeConditionProperties.getConditions().Model for the condition attribute of
indirect client authorizations.Constraint validation that may be applied to
ProfileAttributeConditionProperties.Defines several
ProfileAttributeConditionPropertiesCustomExpression constraints on the same element.Validator implementation for the
ProfileAttributeConditionPropertiesCustomExpression constraint.Constraint validation that may be applied to
ProfileAttributeConditionProperties.getConditions().Defines several
ProfileAttributeConditionsUniquelyNamed constraints on the same element.Validator implementation for the
ProfileAttributeConditionsUniquelyNamed constraint.Model describing a profile attribute.
JSF Converter for
IProfileAttributeDescriptors.Service providing
IPluginProfileFilterExtensions for client descriptors.Helper class for creating user profiles (pac4j) for test purposes.
Bean for the project sub menu "access".
Model for persisting authenticator configurations for a project
Deprecated.
Use
ProjectCreationBean insteadCentral bean for creating projects (except for import)
Bean zur Verwaltung der projektspezifischen Formular-Datentabelle
Runnable for deleting all quartz jobs/triggers of the given workflow trigger type and deleted project.
Entity for project-specific double-opt-in data
Deprecated.
For creating duplicates of
ProjektsDeprecated.
This event handler has been deprecated in version 8.0.0 because
LoginEvent are no longer fired.Exporter for
Projekt entitiesBean for editing the groups of a project
Configuration for a project for detecting duplicate submissions.
Deprecated.
Adds project identity check data entity for projects that have an identity check template set.
Bean handling the import of projects (including the wizard)
Import config for
ProjektsDeprecated.
Use
ProjectImporter insteadImporter for XFC
ProjektsDeprecated.
Updates the specfic inboxes, adding system columns to all existing specific inboxes
Entity for project-specific invitation data
Deprecated.
Helper class for (safely) creating/updating formcycle
projects.Bean for all designer pages that depend on a project.
Helper for the workflow model bean that loads the model data from the DB.
Migrates all project passwords to project_authenticator_attr table
Deprecated.
Use
UserPermissionsBean instead.Handles application events that are relevant to the from files view.
Handles designer conversation events that are relevant to the from files designer tab.
Deprecated.
Event for when an entity was modified, either when it was created, updated, or deleted.
Handles creation and customization of a simple form share link
A tag that is associated with a
project.The default implementation of
IProjectTagDao that can be accessed via DaoProvider.Deprecated.
Use
ProjectImportBean insteadEvent signaling that the data of a project have changed.
Bean for the form overview menu.
Utility class for checks and operations on the entity
ProjektPOJO model class for the editing the available versions of a project.
Model class for the editing the list of project versions, including form versions and workflow versions.
Factory for creating view models representing project versions
POJO view for selecting some attributes of a
Projekt in the inbox.Model for displaying only the necessary information of a project
Deprecated.
The entity
Projekt contains the core functionality of the system.API class for manipulation of
Projekt entities.Deprecated.
Use
ProjectExporter insteadThe Class ProjektHandler.
Deprecated.
In a future formcycle version old project exports (export version < 2.0.0) won't be importablable
anymore.
Deprecated.
This is part of the old rest API.
Deprecated.
This is an experimental API and was never supported and should never have been used.
Alle Status, welche bei der Analyse der zu aktualisierenden Projektdaten auftreten können
Hilfsklasse für Aufgaben, die Projekte betreffen.
Static functions for checking access permissions related to PROMA operations.
Provides global access to the current
IPromaApiProvider for interacting with the PROMA API.Static factory methods for various different
IPublicPromaInvocationContext.This class is used to manage PROMA API instances for interacting with the PROMA API.
This class has several methods for processing plugin information to get update information about plugins from PROMA
and process it further.
Functions for installing and updating plugins from the remote PROMA repository.
Utility methods to extract data from PROMA API models.
Utility methods for creating various POJOs for the PROMA API.
POJO for
IPromaResponse.Additional functions for reading and writing store items.
JSF component for the properties panel of the workflow designer.
Handler class for
PropertiesForm, registers the appropriate functions.Tag handler that lets you change the params of the properties form on a per action source basis, e.g. for a certain
command button or AJAX request.
Model for the properties panel to the right of the workflow designer.
Update to move application properties from file to database.
'Checked Exception' für Probleme bei der Property-Verarbeitung.
Custom pac4j
matcher for checking if the web endpoint of the request is a
protected endpoint.Bean für die aktuelle Session und deren Informationen
Deletes protocol entries for clients
Bean for cleaning up the protocol
Helper class for setting up protocol clean up jobs
Job for cleaning up all protocols on the system according to the configuration in the
SystemPropertysDie Entität PeDokumentation stellt einen Protokolleintrag dar, der angelegt wird, sobald etwas protokolliert werden
soll, was weder einem Statuswechsel noch einer Aktionsabarbeitung entspricht.
Deprecated.
The Class ProtokollHandler.
Utility methods for creating
AProtocolEntrys and saving them in the database.POJO model holding the data for different links to open the form, such as on the master or frontend server.
Deprecated.
This is part of the old workflow engine.
Simple POJO that combines a
PROMA API call to a specific endpoint with an invocation builder for a
particular configuration of that end point.Diese Klasse ermöglicht den lesenden Zugriff auf fixe, im System enthaltene Werte.
Kapselt alle relevanten Request-Parameter
Default filter criterion supplier.
Default sorting criterion.
Represents a qualified submit button, i.e. a pair of
qualifier and button name.Provider for the qualified submit button elements available in the current form version during workflow editing and
validation.
Class to provide an database-connection for the scheduling
Factory for creating models containing detail information about quartz jobs
Utility class providing methods for handling data queries
Bean for quicklinks.
A range map to which ranges can be added.
Utilities with additional methods on
Ranges.Default POJO implementation of
IReadEntityRefsParams.Factory for GSON type readers
Default POJO implementation of
IReadPlaceholdersParams.Default implementation of the
IRedirectAction.An exception that also indicates a
redirection action.Event that is triggered when the name of a form element was refactored.
JSON provider that allows treating Java object as JSON objects.
Scanner that finds all
IListenerRegistrator implementations and registers them.Parameters that can be passed as the second parameter to the client side JavaScript method
Flowchart.registerBaseCondition.Reinitialisierung der MySQL-Projekttabellen aufgrund eines Encodingproblems
POJO model for the state added push event.
Helper methods for
<p:remoteCommand>, such as reading parameters and returning a value.Default POJO implementation of
IRemoteEventExecutionResult.POJO model for the PDF importer IDs removed event.
Renames all group names of timed workflow trigger quartz trigger and jobs from scheme
_WORKFLOW_TRIGGER_ to
_WORKFLOW_TRIGGER__pid#_cid# .
Parameters for the render item remote command, see
FormRenderHelper.CDI model bean for accessing authorization context information of the current request.
CDI model bean for accessing view availability context information of the current request.
CDI model bean for accessing the client & backend view of the current request.
CDI model bean for accessing the current web context consisting of
HttpServletRequest &
HttpServletResponse.CDI model bean for accessing common designer information of the current request.
CDI model bean for accessing the form record of the current request.
Redirects to the clients final callback URL while adding the all request parameters of the initial request.
Factory for
IPublicPromaInvocationContexts.CDI model bean for accessing the web endpoint of the current request.
Implementation of
IBaseWorkflowEnvironmentData that takes the data from the current designer view scope.Constraint validation that may be applied to
TimeDuration.Defines several
RequiredTimeDuration constraints on the same element.Validator implementation for the
RequiredTimeDuration constraint.Default POJO implementation of
IResolvedAttachment.Default POJO implementation of
IResolvedAttachmentItem.Builder to build
ResolvedAttachmentItem.Default POJO implementation of
IResolvedAttachmentList.Default POJO implementation of
IResolvedAttachmentSourcePreviousNode.Default POJO implementation of
IResolvedAttachmentSourceSearch.Default POJO implementation of
IResolvedAttachmentSourceUpload.Default POJO implementation of
IResolvedFile.Default POJO implementation of
IResolvedFileList.Default POJO implementation of
IResolvedFileSourceAttachment.Default POJO implementation of
IResolvedFileSourceFormFile.Default POJO implementation of
IResolvedFileSourceClientFile.Default POJO implementation of
IResolvedFileSourceUploadElement.Default POJO implementation of
IResolvedFileSourceUrl.Default POJO implementation of
IResolvedFileSourceWorkflowNode.Deprecated.
This implementation is returned only by deprecated methods, use non-deprecated methods instead, e.g.
Default POJO implementation of
IResolvedResourceItem.Builder to build
ResolvedResourceItem.Exception that is thrown when access to a resource could not be checked due an unhandled or unforeseen error.
Helper for creating the aggregate resource bundle used by the workflow designer.
Bean-Klasse zum Anzeigen von Resourcen.
Factory for common
IResourceMatchers.Helper methods for refactoring content in resource files.
Utility class for handling entity resources
Builder for creating
rewrite URI resolvers.Represents an RGB color triplet.
Updates all roles for new
EAccessProperty that were added in v6.Updates all roles for new
EAccessProperty that were added in v6.Updates all roles for new
EAccessProperty that were added in v6.Updates all roles for new
EAccessProperty that were added in v6.4Updates all roles for new
EAccessProperty that were added in v6.4Updates all roles for new
EAccessProperty that were added in v6.6.1Updates all roles for new
EAccessPropertys that were added in version 7.0Updates all roles for new
EAccessPropertys that were added in version 7.0.11Updates all roles for new
EAccessPropertys that were added in version 7.0.13Updates all roles for new
EAccessProperty that were added in version 7.1Updates all roles for new
EAccessProperty that were added in version 7.1Updates all roles for new
EAccessProperty that were added in version 7.3Updates all roles for new
EAccessProperty that were added in version 7.4Deprecated.
This event handler has been deprecated in version 8.0.0 because
LoginEvent are no longer fired.Die Klasse Rolle dient dazu, die Rechte eines
Benutzer festzulegen.API class for manipulation of
Rolle entities.The default implementation of
IRolleDao that can be accessed via DaoProvider.Model class for rolling log files
File manager for accessing rolling files of
XRollingFileAppenderImplementation of an HTTP servlet
Filter which adds the SameSite attribute to cookies, until the Java API
supports it natively, if ever.SAML 2.0 service provider meta data (
EntityDescriptor) generator.SamlAuthenticatorProperties<TAuthenticator extends IAuthenticator<E>,E extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>
Model class for accessing the properties of an authenticator of type
EAuthClientType.GENERIC_OPENIDCONNECT in
a structured manner.SAMLWrapper<T extends IAuthenticator<E>,E extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>
Deprecated.
Use
SamlAuthenticatorProperties instead.Factory for creating Sardine instances.
Deprecated.
Instanziiert Formdata-Adapter für die verschiedenen Formulartypen
Constants for the
Schedule components, mainly names of properties defined by full calendar.Constants for full calendar events.
Manager-class for starting, stopping and removing schedules jobs
A list of
plugin update results for a particular scope, either a workspace scope or a
system scope.Bean for switching the view scope (e.g. client scope or system scope).
Simple POJO class for a search term with string key and a string value.
Factory for securely pre-configured factories for processing XML
Serlvet context listener for executing common security initialization and shutdown tasks.
Helper for working with formcycle entities.
Bean for helping with security
Helper class for working with LDAP connections.
Helper for working with
pac4j.Helper for working with plugins.
Helper for working with profiles.
Helper for dealing with request in formcycle.
Helper for working with
IWebEndpoints.Model for a selected plugin store item.
This bean stores the currently selected item for each page/view throughout the session.
A
IChoiceItem that is also a SelectItem and can be used in JSF UIs.An
IChoiceGroup with that is also a SelectItemGroup and can be used in JSF UIs.Default POJO implementation of
ISendMailReport.Default POJO implementation of ISentMailData.
Annotation to indicate the order of an
IOrderableExtends the serenity menu to provide support for icons from different icon fonts.
Deprecated.
Since version 8.0.0 no longer necessary.
Factory for creating
GUI server models.Model for selecting the server to use on the form publishing page.
Deprecated.
Since version 8.0.1.
Factory for the data of servlet events.
Factory for creating data models for the result of servlet event executions.
Default POJO implementation of
IServletResponse.Helper class for working with sessions.
Deprecated.
Deprecated.
Use
de.xima.fc.web.common.utils.SessionUtilsSimple bean for storing and accessing data in an HTTP session.
Bean for event subscription and handling of the application
If the there is no session / session expired, then a new session will be created, the requested URL will be saved in
that session and the user will be redirected to the
EPublicView.WELCOME so they can sign in.A message like a
FacesMessage, but with more additional information required for making the message useful
during later in the session.Helper for working with
HttpSessions.Factory for creating
SessionStores.Manager for working with user that is authenticated within a backend session.
HTTP session listener that set the
com.sun.faces.application.view.activeViewMapsSize on the session.Generic class for a setting - a level or placement that a knob or control is set to.
A builder for configuring the options of a
Setting.Bean validation value extractor for
Setting that extracts the
Setting.getValue().API class of setups.
The Class SetupHandler.
Severity levels for bean validation.
Severity level
Error for bean validation, see Severity.Severity level
Warning for bean validation, see Severity.AlgorithmDescriptor for signature algorithm "http://www.w3.org/2007/05/xmldsig-more#sha256-rsa-MGF1"Model holding data for user signup.
Deprecated.
use
TextMailData insteadModels a single attachment that may come from one of multiple sources, such as upload form elements, creates by
another action, or with a specific name.
Custom label for the
SingleAttachment.getAttachment() property.Custom label for the
SingleAttachment.getSearchFilenamePattern() property.Deprecated.
POJO with parameters for
SingleConditionCheck.test(FormValueConditionData).Predicate that checks a simple condition.
Models a single file that may come from multiple sources, such as client file, project files or external files
referenced via a URL.
Custom label for the
SingleFile.getResource() property.Custom label for the
SingleFile.getSearchFilename() property.Custom label for the
SingleFile.getUrl() property.Remove validators during prevalidate and restore them during postvalidate.
Deprecated.
Remove as soon as updating to at least OmniFaces 2.3 o:skipValidations
Compares two strings and ignores upper / lower case.
Builder for the event data for running a specific trigger, specified by its ID.
Deprecated.
Decorates a
CompletableFuture and introduces the idea of an eventual return value that one wishes to obtain
eventually.Maps between some well-known classes and their standard names.
Standard implementation for
IResolvedAttachmentListProcessor with the standard error behavior used by most
built-in actions.Standard implementation for
IResolvedFileListProcessor with the standard error behavior used by most built-in
actions.When the state list was updated in the workflow designer.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).When the state list was updated in the workflow designer.
CDI-injectable provider for the states available in the current workflow version during workflow editing and
validation.
When the state list was updated in the workflow designer.
Deprecated.
Deprecated.
When the state list was updated in the workflow designer.
Model for assigning form records to new states
Job for triggering the new workflow engine when a form record remains in a certain state for a certain amount of
time.
Utility methods for
EWorkflowTriggerType.FC_STATE_TIMER.Worker for invoking a trigger of the new workflow for the
EWorkflowTriggerType.FC_STATE_TIMER trigger.Deprecated.
Use the new workflow engine.
Builder for creating
URI resolvers with static URIs (not rewritten).Deprecated.
This entity is part of the old workflow engine.
Deprecated.
Use
WorkflowStateAPI and the new workflow engine.Deprecated.
Deprecated.
This belongs to the old workflow engine which will be removed.
Deprecated.
Deprecated.
since 7.0.0
Deprecated.
since 7.0.0
Deprecated.
The old workflow engine will be removed, use the new workflow engine.
Factory for
IStatusReferenceItemsDeprecated.
This is part of the old rest API.
Model that describes the meta information provided in a project file from the form store.
Exception thrown when a form store meta could not be validated, see
StoreFormMetaValidationException.Validation result returned by the
StoreFormMetaValidator.Validates the
metadata.json data contained in a form store file.Model that describes a plugin requires by a form store project file.
String data that can be added to a HTTP request.
Utility Class containing helper methods for working with a data grid model of type
StringDeprecated.
This is not used anymore and can be removed.
CDI-injectable provider for the submit button elements available in the current form version during workflow editing
and validation.
Represents the state of a submitted appointment form field.
POJO for the workflow designer drawer panel that represents a sub category with nodes and triggers.
Builder for a
ISummaryKeyValueModel POJO.Default POJO implementation of
ISummaryKeyValuePair.Authenticator for retrieving the SUPER USER
UserProfile by validating the credentials.Bean similar to
UserCredentialsSigninBean but only handles super user login for the special /admin
page that is reserved for super user login.Implementation of
IWorkflowExecutionPostProcessor that checks whether a servlet response was set by the
workflow.Implementation of
IWorkflowExecutionPostProcessor that checks whether a WorkflowState was set by the
workflow.Implements
IResourceDescriptor by lazily obtaining data from a supplier.Model containing information of support inquiries
Builder for
SupportInquiryDataEntity model for user authenticators in system scope
API class for reading and writing
SystemAuthenticator entities.Update all system authenticators to set the
SystemAuthenticator.isAllowAllClients() flag based on the
SystemAuthenticator.getAllowedClients() list.The default implementation of
ISystemAuthenticatorDao that can be accessed via DaoProvider.Handler implementation for reading and writing
SystemAuthenticator entities.Entity for storing informations about the already performed system-updates
Builder for system dashboard panel entries.
Providing GUI access to system information
Utility class for accessing system information
Entity for system messages.
This class holds the localized name and message of a
SystemMessage.Entity for system-wide plugins
Entity for the configuration of an system-wide plugin
Entity for the binary data of an system-wide plugin
Entity for the binary data of an system-wide plugin
Entity for system-wide properties
Deprecated.
use
UpdateBean.getSystemUpdate() insteadMeta information model for
UserProfiles in the system scope.POJO model for a tab in the designer, such as the workflow or form editor tab.
Component model showing its content as an iframe in the main window view.
Component model showing its content as a ui:include in the main window view.
Actions operating on a
TabViewModel.POJO model holding the data for managing the individual tabs of the new designer.
PrimeFaces component for the Tagify JavaScript component (MIT license): yairEO/tagify
PrimeFaces component for the Tagify JavaScript component (MIT license): yairEO/tagify
A pair of a
FacesMessage with its client ID.Wrapper to treat a
IRemoteEventExecutionResult as a
IWorkflowResponse.View model corresponding to the WorkflowTask entity, used by the
Flowchart component.A task queue implemented as a list, but only with the methods actually required.
POJO implementation of a
ITaskQueueExecutionResult.POJO implementation of
ITaskWithName.An
AutoCloseable wrapper for a File that deletes that file when closed.Model representing
Textbaustein dataParameters for the create template remote command, see
FormTemplateHelper and
FormDesignerTemplateBean.createFormTemplate() / FormDesignerTemplateBean.updateFormTemplate().Exporter for
Textbaustein entitiesDeprecated.
Bean für die aktuelle Session und deren Informationen
Servlet for providing templates
Bean for handling data source manipulation through excel-like sheet
Adds a new HTML template for appointment management
Adds new MAIL templates for the new user management.
Helper methods for classes in the
java.time package.Manager for dealing with test clients.
POJO class with details on the formcycle mock system environment created for tests.
Diese Entität ermöglicht eine Zuordnung zw. einem Schlüssselwort und einem dahinterliegenden Text.
API class for manipulation of
Textbaustein entities.The default implementation of
ITextbausteinDao that can be accessed via DaoProvider.The Class TextbausteinHandler.
Diese Klasse dient dazu Textbausteine auszuliefern, hierzu ist die Klasses als Singleton konszipiert.
Model containing basic mail properties
Event for when an entity was modified, either when it was created, updated, or deleted.
Resource for plugin backend themes
A new column was added to the FormVersion entity:
FormVersion.getTheme().Deprecated.
Model class with bean validation for a duration.
Custom label for the
TimeDuration.getDuration() property.Custom label for the
TimeDuration.getUnit() property.Bean for the time duration component.
Job for triggering the new workflow engine when a form record remains in a certain state for a certain amount of
time.
Utility methods for
EWorkflowTriggerType.FC_TIME_POINT.Worker for invoking a trigger of the new workflow for the
EWorkflowTriggerType.FC_TIME_POINT trigger.Technical exception indicating that a token has expired!
Bean for handling TOS (terms of service) agreement of users.
Annotation zur Angabe ob Entity-Attribute an den Client übermittelt und empfangen werden
Annotation zur Angabe ob Entity-Attribute an den Client übermittelt und empfangen werden
Factory for
IResourceDescriptor that delegate to another descriptor, but transform the resource content in
some manner.Accessor for treating
NodeModels as a tree, so that they can be used with the execution analyzer.Accessor for treating
NodeModels as a tree, so that they can be used with the execution analyzer.ITreeWithDataAccessor for treating WorkflowNodes as a tree, so that they can be used with the
execution analyzer.A
ITreeAccessor for treating WorkflowNodes as a tree, so that they can be used with the execution
analyzer.Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).An iterable that iterates over a tree-like graph, starting at a given node.
An event that is fired when the currently selected tree node (workflow) is changed.
Helper methods for creating quartz triggers.
The key of a workflow trigger that uniquely identifies it within the context of a process.
Factory for creating a trigger key for formcycle specific triggers.
Enumeration of the predefined for trigger groups
View model corresponding to the WorkflowTrigger entity, used by the
Flowchart component.Default implementation of a
ITriggerOnTaskBeginParams.Default implementation of a
ITriggerOnTaskFinishParams.Bean for editing the properties of the selected trigger in the workflow.
Default POJO implementation of
ITriggerPrototypeData.Default POJO implementation of
ITriggerPrototypeDescriptor.A builder for a
ITriggerPrototypeDescriptor.View wrapper model for the elements drawer panel.
CDI-injectable provider for the that makes available all nodes in the entire workflow process that are of a given
type.POJO implementation of
ITriggerWithName.Implementation of a
IComponentValueConverter that provides only a single value, but offers additional methods
to convert this value to different types, see TypePartsConverter.TypeConvertibleMap.Implementation of
IConvertibleMap for the TypePartsConverter.Converter for
UICalendar components that behaves similar to the default converter for those components, but
returns null when the date or time is invalid.Deprecated.
Class providing default FC GUI elements
Deprecated.
This is part of the old workflow, use the new workflow engine.
Validates whether there is no project (form) with the given name.
Name validator for
ClientAuthenticatorsUnique name validator for
ClientCountersA
AUniqueNameValidator for the Mandant.getName()A
AUniqueNameValidator for the FrontendServer.getName()Custom-Validator für die Überprüfung der Eindeutigkeit eines Logger-Namens
POJO for customizing the options
Faces validator that can be applied to input elements used for editing the name of a workflow state, i.e.
Name validator for
SystemAuthenticatorsDeprecated.
Validator for checking if a given email address is valid
Validator for checking if a given email address is existing as an already verified address.
A
AUniqueNameValidator for the WorkflowState.getName()GSON adapter that serializes
Date as UNIX timestamps in milliseconds (since 1970/01/01).POJO for an extracted flowchart snapshot.
Represents a JAR file that was unpacked to the file system.
WHen attempting to read a PDF document that contains an XFA form, but XFA forms are not supported by the engine.
Bean for handling Liquibase / migration / system updates.
Utility class for sending mails with regards to system updates.
Default POJO implementation of
IUpdateCustomParametersParams.Utility methods for creating the update transitions map for the update enums in the sub packages.
Provider for the upload elements available in the current form version during workflow editing and validation.
Meta data about an uploaded file.
Deprecated.
This class was added during development, but never used.
Factory for creating
URI adapters.Factory for creating uri builder contexts.
Factory for creating default
IUriResolver.Extension of the default
SAML2ContextProvider that provides UrlResolvedSAML2MessageContext contexts
instead.Extension of the default
SAML2MessageContext that applies a URL resolver to the assertion consumer service
URLs since the SAML2Client / SAML2Configuration don't apply it (because it is done on initialization
for some reason where there is no web context).DEfault implementation of the
IUrlResource.Implements
IResourceDescriptor via an URL.Rewrites backend URLs to make them context-dependent.
CDI-injectable provider for the URL templates available during workflow editing and validation.
POJO for the binary data from a data URI, with the content type.
Connects
accounts from IDPs to existing user profiles
based on a verified email.Predicate that checks whether a
IndirectClientAuthorization matches a pre-defined user profile.Deprecated.
Use
ClientAuthorizationBean instead.Deprecated.
Benutzers are deprecated.Die Klasse dient der Rechte- und Zugriffsabsicherung für den API-Zugriff.
Factory methods for creating new
UserContext instances.User credentials are the entries of the default formcycle authenticator.
API class for reading and writing
UserCredentials entities.Implementation of the
IUserCredentialsDao for reading and writing UserCredentials entities.Bean for requesting a reset of the user credentials.
Handler implementation for reading and writing
UserCredentials entities.Bean for setting the user credentials of a user profile.
Bean for handling user login with
UserCredentials.Deprecated.
since 8.0.0 Users within clients are defined as
DirectClientAuthorizations.Helper Bean for user discovery using lookup services of authenticators.
Entity representing the email addresses of users which are used by the
UserProfileAPI class for reading and writing
UserEmail entities.Implementation of the
IUserEmailDao for reading and writing UserEmail entities.Handler implementation for reading and writing
UserEmail entities.Bean for displaying and modifying a user profiles emails.
Bean handling the changing of a user profiles primary email address.
Model representing the result of a user query.
Helper class for working with
UserEmailQueryResults.Helper class for querying users by keyword queries.
Bean handling the verification of a user email address.
Factory for creating
IUsers.Deprecated.
Use
InternalUserAuthenticator or an appropriate client for LDAP users instead (see
ClientFactory).Deprecated.
Use the
ClientFactory with a client descriptor for EAuthClientType.FORM instead.CDI-injectable provider for the user groups available in the current client during workflow editing and validation.
Data regarding a user group, used for
IXItemEvaluator.Deprecated.
Event for when an entity was modified, either when it was created, updated, or deleted.
User identities are the connection between
SystemAuthenticators and UserProfiles.API class for reading and writing
UserIdentity entities.Implementation of the
IUserIdentityDao for reading and writing UserIdentity entities.Handler implementation for reading and writing
UserIdentity entities.Bean for displaying and modifying a user profile's emails.
Bean handling the removal of user identities.
Model representing a user from an IDP.
Deprecated.
Bean for displaying / accepting / declining client invitations.
Bean for handling user invitations
E-Mail zur Benachrichtigung eines Benutzers über die Erstellung/Änderung seines Kontos.
Hilfsklasse für Funktionalitäten der Benutzerverwaltung.
Event for when an entity was modified, either when it was created, updated, or deleted.
Bean for handling multi-factor authentication of users by letting them input the authentication code.
Bean for registering multi-factor authentication for user profile using a QR code and an authenticator app.
Bean for handling user permissions
Providing user producers for the
UserFactory.User profiles store information about a specific user that may be able to sign in using multiple
UserIdentitys.Bean for administrating all user profiles within the system.
API class for reading and writing
UserProfile entities.View scoped Bean for handling of displaying and changing user data
Bean for resolving user profile conflicts.
Bean for creating new user profiles from the system view for administration of users.
Implementation of the
IUserProfileDao for reading and writing UserProfile entities.Listener registrator for listeners of the
UserProfileDaoBean for permanently deleting user profiles.
Entity representing files of a user profile
Entity containing the actual data of a user profile file entity
Generates a
formcycle user profile if access to the backend is granted and
none exists.Handler implementation for reading and writing
UserProfile entities.Bean for displaying general information about the user profile.
Bean for the user profile menu in the top right corner
Serves as the endpoint for the user profile merge process.
This entity represents the MFA configuration of a user profile.
API class for reading and writing
UserProfileMfa entities.Implementation of the
IUserProfileMfaDao for reading and writing UserProfileMfa entities.Handler implementation for reading and writing
UserProfileMfa entities.Bean handling the removal of user profile MFA configs.
Model for preferences of a
UserProfile.Properties model class of the
UserProfile entityBean for displaying and modifying a user profile's security settings.
Factory for creating
user profile tasks.Factory for creating
user reference resolvers.Deprecated.
Bean handling the signup process for new users.
Bean handling the completion of the user sign up process.
Complementary bean to the
UserSignupBean for handling the signup process of new users in the signup dialog.FacesConverter for UUIDsModels a reference to another entity via the UUID of that entity.
The
<o:validateBean> allows the developer to control bean validation on a per-UICommand or
UIInput component basis, as well as validating a given bean at the class level.Model representing the result of reading and validating a form store file.
Event that is triggered when the JSF validation for a
PropertiesForm is done for that form.Ausnahme für fehlgeschlagene Validierungen.
UI helper utilities for running the workflow validator and extracting and converting workflow validation messages.
An implementation of
IWorkflowProvider that is available during bean validation of the workflow.Class for validating
Setting.Beschreibung eines Wertes (Name, Typ und Wert).
Default implementation of the
IValueDescriptorFactory.Represents the parameters of form HTTP request as key-value pairs.
Deprecated.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This action is not necessary anymore.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This action is not necessary anymore.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Deprecated.
This is part of the old workflow engine.
Groups all plugins with the same plugin key.
A target plugin that is to be updated.
Bietet grundlegende Versionsinformationen (statisches API für direkten Zugriff und Bean-Getter)
View scoped bean allowing access to data of the current view.
Bean for event subscription and handling of the application
Deprecated.
This event handler has been deprecated in version 8.0.0 because
LoginEvent are no longer fired.Bean that keeps a list of available form-specific inbox views, shown in the sidebar menu to the left.
Bean providing utility methods for working with
IViews.Bean that associates a UUID with each view.
Bean for handling initialization tasks on views.
Deprecated.
Since version 8.0.0 no longer in use.
Model representing a message that is to be shown on view initialization.
Bean for the view settings panel of the new workflow that lets the user change what is dislayed in the flowchart
diagram.
Helper methods for the view settings panel.
Models with the view options for the flowchart, such as whether to draw separator lines between lanes etc.
Utility methods for working
IViewsAuthenticator config model for type authenticator configs that are not persisted
Deprecated.
Model for virtual users such as the SYSTEM user.
API class for manipulation of
Vorgang entities.Deprecated.
use
ProcessCopyUtilThe Class VorgangHandler.
Listeners-Klasse für Listener für DAO-Aktionen eines Vorgangs
Deprecated.
Deprecated.
Used by the old rest like API.
Singleton model allowing access to information about the web app context.
Servlet context listener for executing common initialization and shutdown tasks for all types of web applications
(MS, FS, FS-INBOX).
Models the connection data for a web DAV server.
API class for reading and writing
WebDavAccess entities.The default implementation of
IWebDavAccessDao that can be accessed via DaoProvider.Handler implementation for reading and writing
WebDavAccess entities.Controller bean for the WebDAV management backend menu.
CDI-injectable provider for the WebDAV connections available in the current client during workflow editing and
validation.
Event for when an entity was modified, either when it was created, updated, or deleted.
Helper from the original
SardineFactoryTree node adapter for lazily loading the contents of a WebDAV directory.
A simple WebDav server against which integration tests can be run.
Class for the data block of a
DefaultTreeNode used in displaying a folder structure of WebDAV connectionsChecks authorization to formcycle web endpoints based on the current servlet request, i.e.
Custom pac4j
matcher for checking if the web endpoint of the current request is
available.Manager for working with formcycle web endpoints.
POJO representing the different types of form persist files.
Deprecated.
DO NOT USE!
Utilities for handling widget plugins in the form designer, see
FormDesignerPluginBean.This exception is thrown when a workflow task or node could not be analyzed, see
IWorkflowFlowAnalysis.API for initiating the workflow.
POJO implementation of
IWorkflowAttachmentValue.Bean for handling workflow version backups.
Helper methods for working with workflow version backups.
Model for the selected and available automatic backup versions of the workflow.
Implementation of the
IWorkflowBeanValidator to validate workflow models via the bean validation API.Model with additional context data such as the fonts installed on the system.
Helper class for serializing and deserializing the custom properties model of workflow nodes and triggers, see
ICustomParametersProviding.Custom resource bundle supplier for the workflow.
Handles application events that are relevant to the workflow designer.
Handles designer conversation events that are relevant to the workflow designer.
Conversation request handler bundle for the workflow.
Utility for checking whether a workflow element is available and allowed to be used.
Controller bean for the workflow designer handling node and trigger insertions / updates / deletions, e.g. when a
Word fill node needs to be inserted.Given a
WorkflowTask or WorkflowProcess, contains various maps of WorkflowNodes for quickly
accessing the nodes by a certain index.Helper for extracting referenced entities of workflow elements (nodes and triggers).
Factory methods for basic implementations of
IWorkflowElementTypeProviding without further data.Implementation of
IWorkflowElementWithDeserializedModel that loads the data lazily when requested.Factory class for creating common types of
IWorkflowEventData.Default implementation of the
IWorkflowEventRunner.Exception thrown by the workflow event runner.
Default implementation of
IWorkflowExecutionContext that is used by the WorkflowTaskRunner.External state implementation used for
FlowchartModel.updateExternalState(com.alibaba.fastjson.JSONObject).Helper methods for creating and modifying the
WorkflowExternalState, which is the formcycle specific state
required by the flowchart on the client.POJO implementation of
IWorkflowFileValue.Implementation of
IWorkflowFlowAnalysis that analyzes the execution of a workflow task or process.Methods for initiating the workflow for a given form record.
Listener that registers the bean validation context implementation required by the workflow engine.
Bean that holds the different models (state) required by the workflow.
A workflow node that represents a statement in a workflow task.
API class for reading and writing
WorkflowNode entities.The default implementation of
IWorkflowNodeDao that can be accessed via DaoProvider.Factory methods for creating various kinds of
WorkflowNodes.Handler implementation for reading and writing
WorkflowNode entities.Factory methods for creating various kinds of
WorkflowNode models.POJO implementation of
IWorkflowNodeResult.Each
WorkflowNode can have one or more search terms that are used in database queries to filter nodes.The default implementation of
IWorkflowNodeSearchTermDao that can be accessed via DaoProvider.Helper methods for serializing / deserializing a workflow version.
Exception thrown by the workflow placeholder refactorer.
Methods for processing and replacing placeholders in workflow elements.
Default POJO implementation of
IWorkflowPlaceholderRefactorRetVal with a builder.Simple builder for a
IWorkflowPlaceholderRefactorRetVal.A workflow process that defines which actions are taken when certain events occur during the life cycle of a form
record.
The default implementation of
IWorkflowProcessDao that can be accessed via DaoProvider.Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Diese Exception tritt in der Workflowabarbeitung auf und wird von konkreten Aktionsverarbeitungen (
IProcessing-Implementierungen) geworfen.Provides common data related to the workflow, often used as select options by UI elements.
Helper methods for implementing a
IWorkflowProvider.POJO implementation of a
IWorkflowQualifiedSubmitButton.POJO implementation of a
IWorkflowQueueItem.Controller bean for the workflow designer handling form element refactorings.
Utilities for scanning workflow element model class instances via reflection.
Registry for all workflow element handler.
The request context model that is used to store data temporarily during the duration of an HTTP request.
Bean that stores data that should be cached only for the duration of the current request.
Bean for making resource bundles available to XHTML pages of the workflow designer.
Resource bundle locator used that combines the built-in formcycle bundles, and the bundle provided by a workflow node
or trigger plugin.
Resource bundle locator used that combines the built-in formcycle bundles, and the custom bundle provided by a
workflow node or trigger plugin.
Modelklasse der Antwort einer Workflow-Verarbeitung
Deprecated.
Default POJO implementation of
IWorkflowRunTasksForEventParams.Bean for initializing the workflow designer.
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Describes the state of a
Vorgang.API class for reading and writing
WorkflowState entities.Model for persisting authenticator configuration of a
WorkflowStateThe default implementation of
IWorkflowStateAuthenticatorConfigDao that can be accessed via
DaoProvider.Bean that handles deleting states, creating new states and viewing existing states in the workflow designer.
The default implementation of
IWorkflowStateDao that can be accessed via DaoProvider.Handles the deserialization of deprecated fields in
WorkflowState entitiesHandler implementation for reading and writing
WorkflowState entities.Helper methods for creating and modifying a
WorkflowStateListModel, used by the WorkflowStateBean.Client side model for the available states of the workflow version.
View model of a
WorkflowState that can be sent to the client.Updates the internal name of the received state from 'RESERVED_SYSSTATE_RECEIVED' to the localized name.
Updates the access configuration of existing workflow states to conform to the new security by default
paradigm for workflow states
POJO implementation of a
IWorkflowSubmitButton.Helper methods for creating the summary of workflow elements, shown when clicking on the small info icon at the top
right corner of a node or trigger.
A single workflow task with a program represented by the
WorkflowTask.getRootNode() that is executed when one of its
WorkflowTask.getTrigger() fires.API class for reading and writing
WorkflowTask entities.The default implementation of
IWorkflowTaskDao that can be accessed via DaoProvider.Exception thrown by the task runner when a task could not be executed.
Handler implementation for reading and writing
WorkflowTask entities.Default implementation of a task runner.
POJO implementation of
IWorkflowTaskRunnerParams with a builder.A builder for creating the
IWorkflowTaskRunnerParams.Helper class that takes an instance of
IWorkflowTaskRunnerParams and return a new instance with appropriate
defaults supplied for all missing values.A workflow trigger that start a
WorkflowTask when a certain event occurs.API class for reading and writing
WorkflowTrigger entities.Runnable for deleting all quartz jobs/triggers of the given workflow trigger type and deleted form records.
The default implementation of
IWorkflowTriggerDao that can be accessed via DaoProvider.Factory methods for creating various kinds of
WorkflowTriggers.Handler implementation for reading and writing
WorkflowTrigger entities.Utilities for implementing workflow trigger handlers.
Default POJO implementation of
IWorkflowTriggerJobDetails with a constructor that extracts the data.Factory methods for creating various kinds of
WorkflowTrigger models.Each
WorkflowTrigger can have one or more search terms that are used to decide whether a certain trigger
applies to a certain event.The default implementation of
IWorkflowTriggerSearchTermDao that can be accessed via DaoProvider.Bean for controlling the validation aspect of the workflow flowchart and node / trigger properties.
This exception is thrown when an error occurs during workflow validation.
POJO implementation of a
IWorkflowValidationMessage.View model that stores the current validation state of the workflow being edited.
Parameters common to both the
IWorkflowLocalHandlerValidationContext and the
IWorkflowGlobalHandlerValidationContext.A builder for configuring the workflow validation context.
POJO implementation of a
IWorkflowValidationResult.Entry point for validating the entire workflow of a project, or just parts of it (single tasks, triggers, or nodes).
Builder for creating a
WorkflowValidator.Utility methods for
WorkflowValidator implementing custom logic required for validation.Represents the version of a project's workflow.
API class for reading and writing
WorkflowVersion entities.File descriptor for the JSON data of a workflow version backup.
The default implementation of
IWorkflowVersionBackupDao that can be accessed via DaoProvider.JSON data with the backup of a workflow version.
The default implementation of
IWorkflowVersionDao that can be accessed via DaoProvider.Handler implementation for reading and writing
WorkflowVersion entities.When persisting a
WorkflowProcess entity graph, keeps track of all workflow entities that need to be created,
updated, and deleted.A workspace scope in formcycle, either the system scope or a
client scope.Annotation for injecting the rewritten request.
Wraps an existing
IResourceDescriptor with a different URI.POJO implementation of
IWriteEntityRefsParams.Default POJO implementation of
IWritePlaceholdersParams.Factory for GSON type writes
Factory for creating logging components
Encapsulates the JSON object of a button action of a button of a
XButtonList and provides access to the
action's properties.Encapsulates the JSON object of a button of a
XButtonList and provides access to the button's properties.This helper class for the implementation of a
Cache.Utility class for operations on collections and iterables.
Utilities for
Comparator and Comparable.Utility methods for
CompletionStages and CompletableFutures.A
Function which may throw a checked exception.Wrapper class for console appender configs
Handler for the container form element.
Handler for the invisible container form element.
Formatter for
DatesUtility class for handling dates
Wrapper for rolling file rollover strategy
Wrapper for a delete rollover action of
XDefaultRolloverStrategyHelper for DOM related features.
Default values for the settings in the various
*.properties configuration files used by formcycle.Default values for the various settings in the
application.properties configuration file.Default values for the various settings in the
cluster.properties configuration file.Default values for the various settings in the
database.properties configuration file.Defaults for frontend server settings in the
application.properties configuration file.Defaults for KERBEROS settings in
kerberos.properties configuration file.Default values for the various settings in the
mail.properties configuration file.Constants with the names of the settings in the various
*.properties configuration files used by formcycle.Constants with the names of the settings in the
application.properties configuration file.Constants with the names of the settings in the
cluster.properties configuration file.Constants with the names of the settings in the
database.properties configuration file.Constants with the names of the settings in the
logging.properties configuration file.Deprecated.
since version 8.0.0
Constants with the names of the settings in the
mail.properties configuration file.Deprecated.
Deprecated.
The checks of this filter are integrated in
WebEndpointAuthorizer.Context of a backend user session.
Deprecated.
Deprecated.
Kontext einer Formcycle-Nutzersession.
Diese Klasse kapselt das Formular-Persist, ermöglicht es dieses mit Werten zu befüllen, zu validieren und
entsprechend zu rendern.
Deprecated.
Deprecated.
Klasse zum Kapseln der Regulären Ausdrücke für die Validierung
Builder-Class for generating the list of includes.
Model wird für Validierungsregelsn, welche aus Plugin-Implementierungen gewonnen werden, verwendet.
Handler to invoke plugin render callbacks, used by the
XFormRenderer.Default POJO implementation of
IXFormRenderConfig.Diese Klasse dient zum Validieren der Formulareingabefelder sowie zur Validierung von Querverbindungen zwischen
diesen.
Wrapper for a variable JSON object from the form persist (
designer.getPersist().variables).Customizable X-Frame-Options Header matcher.
Central class for managing the creating of clients and system-updates
Utilities related to
java.util.functionSimple POJO implementation of
IXGlobalValidationParams.Helper methods for
Graph and ValueGraph data structures.Creates an HTML compliant iframe, which requires a closing tag.
This class should have been called HtmlLink.
Klasse welche die Whitelist- und Blacklist-
IXItemEvaluator beinhaltet.Wrapper to check evaluate the render and read-only conditions of items.
Wrapper-Klasse welche die unterschiedlichen
XItemConditions beinhaltetEine Klasse welche die Kombinationen von
XPropertyValues zu ihren zu überprüfenden Werten beinhaltet.Eine Klasse welche die Kombinationen von
XPropertyValues zu ihren zu überprüfenden Werten beinhaltet.Eine Klasse welche die Kombinationen von
XPropertyEnums zu ihren zu überprüfenden Werten beinhaltet.Helper for working with properties of
XItem.Static methods for finding the localized value of an
XItem's property.Utility class for providing default languages
Deprecated.
Vergleicht 2 XLogAppender nach ihrem Namen.
Wrapper model for accessing/modifying logger components of Logger
PropertiesConfigurationWrapper model for Logger configs
Deprecated.
Utility class for operations on
MapsHelper functions for
Path instances.Wrapper class for logging pattern layouts
Default POJO implementation of
IXProcessUploadResult.An enumeration of all properties a form element may possess.
Wrapper class for logging rolling file appenders
Form element handler for select items.
Wrapper for size based rolling file trigger policy
CDI-injectable provider for the XSL templates available during workflow editing and validation.
Hilfsklasse für XSL-Transformationen bis Version 2.0
Utility methods for
StageChains.Wrapper class for logging threshold filter configs
Wrapper for time based rolling file trigger policy
Utilities for
UUID.Simple POJO implementation of
IXValidationParams.A simple POJO implementation of
IXValidationResult.