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.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.
BPMN modeler for nodes that execute like a binary selection,
e.g. an if-else node.Base bean for multiple condition UIs.
Indicates that execution of a workflow node ended abruptly.
A simple builder for an
AbstractAbruptCompletionExceptionDeprecated.
use
AFileEntityDeprecated.
use
AFileDataEntityDeprecated.
Diese Klasse ist die Elternklasse aller Entitäten und beinhaltet die Attribute, die in jeder Entität vorhanden sein
müssen.
Abstract implementation of
IHeaderTable.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.
Used by a node to indicate that the node completed abruptly by issuing a break or continue statement that jumps out
of the current loop iteration.
A simple builder for configuring a
NodeReturnedException.Diese Klasse ist die Superklasse von denen alle neudefinierten Exceptions erben sollen.
Diese Klasse ist die Superklasse von denen alle neudefinierten Exceptions erben sollen.
Interface for checking access permissions for users.
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 ProjektA
Control for adding a new item to a list value.A
Control for adding a new entry to a map value.Custom 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.A
Control for adding a new entry to a record value.A
Control for adding a new entry to a record value.Helper class for generating the data for the workflow element info panel.
Deprecated.
Abstract class with different CRUD operations for entities of the type
ITransferableEntity.Abstract bean base class for displaying or editing the details of a single entity
Deprecated.
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.Abstract base class for entities providing the actual file data of
file entities.Base POJO implementation of
IFileEntityView with fields for all getters and setters.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.TRIGGER_DOES_NOT_EXIST error.Exception data class for the
EResourceItemResolutionError.TRIGGER_DOES_NOT_PROVIDE_FILES error.Exception data class for the
EResourceItemResolutionError.TRIGGER_NOT_FIRED 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.Abstract base class for file meta entities.
Exception class for the various kinds of
EFileProvisionHandleErrors with additional data.Exception data class for the
EFileProvisionHandleError.ATTACHMENT_COULD_NOT_BE_SAVED error.Exception data class for the
EFileProvisionHandleError.FILE_COULD_NOT_BE_READ 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).Abstract class for file resources that are dependent on a key.
Abstract class for resources that are dependent on a key.
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.
POJO for the in port, out port and port direction of an
IWorkflowBpmnAlignmentItem.Base class for the different models describing one of the possible
loop item
sources.Base class for item sources for the for-each loop that require a CSV format.
Client finder that finds all clients of the config
Clients.Abstract base class for entity localizations
Abstract base class for localized file meta entities.
Abstract base class for
localized scoped files.Diese Klasse ist die Elternklasse aller Entitäten und beinhaltet die Attribute, die in jeder Entität vorhanden sein
müssen.
Base class for BPMN modelers that can be represented as a
message start event.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.
A bundle that contains all the individual APIs.
A bundle that contains all the individual APIs.
A bundle that contains all the individual APIs.
A bundle that contains all the individual APIs.
A bundle that contains all the individual APIs.
A bundle that contains all the individual APIs.
Represents a general API call to an endpoint.
Represents a general API call to an endpoint.
Represents a general API call to an endpoint.
Represents a general API call to an endpoint.
Represents a general API call to an endpoint.
Represents a general API call to an endpoint.
An interceptor that can be used to react to and modify calls to REST API endpoints.
An interceptor that can be used to react to and modify calls to REST API endpoints.
An interceptor that can be used to react to and modify calls to REST API endpoints.
An interceptor that can be used to react to and modify calls to REST API endpoints.
An interceptor that can be used to react to and modify calls to REST API endpoints.
An interceptor that can be used to react to and modify calls to REST API endpoints.
Defines the interface for the API client.
Defines the interface for the API client.
Defines the interface for the API client.
Defines the interface for the API client.
Defines the interface for the API client.
Defines the interface for the API client.
A simple builder for creating the configuration of an
ApiClient.A simple builder for creating the configuration of an
ApiClient.A simple builder for creating the configuration of an
ApiClient.A simple builder for creating the configuration of an
ApiClient.A simple builder for creating the configuration of an
ApiClient.A simple builder for creating the configuration of an
ApiClient.Encapsulates the configuration for the
ApiClient.Encapsulates the configuration for the
ApiClient.Encapsulates the configuration for the
ApiClient.Encapsulates the configuration for the
ApiClient.Encapsulates the configuration for the
ApiClient.Encapsulates the configuration for the
ApiClient.Mixin to simplify CRUD (create-read-update-delete) operations on entities implemented via the
Configuration.ApiProvider
layer .Exception thrown by various REST API methods.
Exception thrown by various REST API methods.
Exception thrown by various REST API methods.
Exception thrown by various REST API methods.
Exception thrown by various REST API methods.
Exception thrown by various REST API methods.
Wraps a prepared API request call and provides different styles of executing the request, both synchronously and
asynchronously.
Wraps a prepared API request call and provides different styles of executing the request, both synchronously and
asynchronously.
Wraps a prepared API request call and provides different styles of executing the request, both synchronously and
asynchronously.
Wraps a prepared API request call and provides different styles of executing the request, both synchronously and
asynchronously.
Wraps a prepared API request call and provides different styles of executing the request, both synchronously and
asynchronously.
Wraps a prepared API request call and provides different styles of executing the request, both synchronously and
asynchronously.
An authentication that uses a given API key for authentication.
An authentication that uses a given API key for authentication.
An authentication that uses a given API key for authentication.
An authentication that uses a given API key for authentication.
An authentication that uses a given API key for authentication.
An authentication that uses a given API key for authentication.
Factory for creating
PagedResults for API queries.API-Provider-Klasse welche alle verfügbaren Unter-APIs zur instanziiert zur Verfügung stellt
Represents the result of a REST API call.
Represents the result of a REST API call.
Represents the result of a REST API call.
Represents the result of a REST API call.
Represents the result of a REST API call.
Represents the result of a REST API call.
Common interface for all API response adapters.
Factory for creating API response adapters.
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.
Abstract base class meant for
IPluginWorkflowNode plugins that only wish to provide a do-until loop with a
custom test.A formcycle plugin that provides additional features to an existing formcycle application.
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.Abstract base class meant for
IPluginWorkflowNode plugins that only wish to provide a while loop with a
custom test.BPMN modeler for nodes that execute like a post-test loop, e.g.
a do-until loop (do-while loop).Annotation for fields that defines a condition whether the field is applicable or not, by evaluating an EL
expression.
The connection type for combining multiple expressions.
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.Placeholder provider for appointment placeholders.
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.
BPMN modeler for nodes that execute like a pre-test loop, e.g.
a while loop.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.
Abstract base class for
REST API resources.Abstract base model representing a page of resources provided by the PUBLIC REST API.
Abstract base class for providing REST services via their packages.
An unmodifiable view of an array as a list.
Abstract base class for scoped file meta entities.
Abstract base model representing a page of
serializables provided by the PUBLIC REST API.Base class for
BPMN modelers for modeling nodes that represent
simple service tasks in the BPMN model, usually business logic actions.A post-processor for the service task layout, see
createTaskLayoutPostProcessor.Abstract class for an elfinder connector, based on Java servlets.
Base class for servlet parameters classes.
Deprecated.
use
MultipartRequestView model for layout settings related to various
BPMN elements in BPMN diagrams.Base builder for the event data for running a specific trigger, specified by its ID, that also require a form record.
Event data for running a specific trigger, specified by its ID.
Component class for the
<xp:connectTimeout /> component.Deprecated.
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.
An assignment from a name to a value.
An property statement assigning a value to a named property.
Contains all methods that associate derived quantities with the current state.
Stores quantities derived from the current state.
View model for layout settings related to
associations in BPMN diagrams.Base class for
BPMN modelers for modeling triggers that
represent simple start events in the BPMN model.A post-processor for the start event layout, see
createStartEventLayoutPostProcessor.Helper class for modeling a workflow element as a
structured BPMN part.Base class for statistics beans.
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.A
IValueDescriptor for the metadata of an attachment, consisting of its UUID, source, and
optionally a file.Builder for creating a value that conforms to the
AttachmentDescriptor value descriptor.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 and returning that form record.POJO model for the metadata of a form upload, identified by its UUID.
POJO implementation of
IAttachmentValueDescriptor.Type safe builder for a list of graphviz dot graph attributes.
The
arrowhead attribute.The
arrowsize attribute.The
arrowtail attribute.The
bgcolor attribute.The
class attribute.The
cluster attribute.The
clusterrank attribute.The
color attribute.The
constraint attribute.The
dir attribute.The
style attribute for edges.The
edgetooltip attribute.The
xlp attribute.The
xlabel attribute.The
fillcolor attribute.The
fontcolor attribute.The
fontname attribute.The
fontsize attribute.The
root attribute for graphs.The
headlabel attribute.The
headtooltip attribute.The
with attribute.The
label attribute.The
lp attribute.The
labelfontcolor attribute.The
labelloc attribute.The
labeltooltip attribute.The
margin attribute.The
root attribute for nodes.The
nodsep attribute.The
style attribute for nodes.The
ordering attribute.The
pencolor attribute.The
penwith attribute.The
peripheries attribute.The
rankdir attribute.The
ranksep attribute.The
shape attribute.The
showboxes attribute.The
style attribute for sub graphs.The
taillabel attribute.The
tailtooltip attribute.The
tooltip attribute.The
truecolor attribute.The
with attribute.A builder for an
EdgeAttributeList.A builder for an
GraphAttributeList.A builder for an
NodeAttributeList.A builder for an
SubGraphAttributeList.Mixin for attributes that accept a single color.
Mixin for attributes that accept a color list.
Mixin for attributes that accept a label string.
Mixin for attributes that accept a length with some unit.
Mixin for attributes that accept a length with the unit inches.
Mixin for attributes that accept a length with the some unit.
Mixin for attributes that accept a length with the unit inches.
Mixin for attributes that accept a length with the unit pints.
Mixin for attributes that accept a point.
Mixin for attributes that accept a style list.
A named attribute for a dot graph.
A
AttributeListBuilder.ITypedAttribute that is valid on edges.A
AttributeListBuilder.ITypedAttribute that is valid on graphs and edges.A
AttributeListBuilder.ITypedAttribute that is valid on graphs and nodes.A
AttributeListBuilder.ITypedAttribute that is valid on graphs, nodes, and edges.A
AttributeListBuilder.ITypedAttribute that is valid on graphs.A
AttributeListBuilder.ITypedAttribute that is valid on graphs and sub graphs.A
AttributeListBuilder.ITypedAttribute that is valid on graphs, sub graphs, and edges.A
AttributeListBuilder.ITypedAttribute that is valid on graphs, sub graphs, and nodes.A
AttributeListBuilder.ITypedAttribute that is valid on graphs, sub graphs, nodes, and edges.A
AttributeListBuilder.ITypedAttribute that is valid on nodes, and edges.A
AttributeListBuilder.ITypedAttribute that is valid on graphs and nodes.A
AttributeListBuilder.ITypedAttribute that is valid on graphs and edges.A
AttributeListBuilder.ITypedAttribute that is valid on graphs and nodes.A
AttributeListBuilder.ITypedAttribute that is valid on sub graphs, nodes, and edges.A
AttributeListBuilder.ITypedAttribute that is valid on sub graphs.Models the type of a graphviz element attribute.
A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs and edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs and nodes.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs, nodes, and edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs and sub graphs.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs, sub graphs, and edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs, sub graphs, and nodes.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on graphs, sub graphs, nodes, and edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on nodes.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on nodes, and edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on nodes.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on sub graphs.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on sub graphs and edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on sub graphs and nodes.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on sub graphs, nodes, and edges.A
AttributeListBuilder.ITypedAttributeDescriptor that is valid on sub graphs.List of pre-defined
AttributeListBuilder.TypedAttributes.An attribute statement assigning default properties to a graph, node, or edge.
Abstract base class for faces validators that check whether a certain field of a bean is unique amongst all existing
entities (within a certain scope).
Abstract base class for faces validators that check whether a certain string field of a bean is unique amongst all
existing entities (within a certain scope).
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.
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 dataAuthenticateRequest
A handler that applies the required security to a request.
A handler that applies the required security to a request.
A handler that applies the required security to a request.
A handler that applies the required security to a request.
A handler that applies the required security to a request.
A handler that applies the required security to a request.
The API for making structured REST API calls to the "AuthenticationApi" endpoint.
Response model for authentication requests, indicating success or requiring MFA.
The status of the authentication request, indicating success or if MFA is required.
Service that provides authentication endpoints
Factory for
IAuthenticationTargets.Adds the authentication target to the authentication attributes of the user profile.
Generator for authentication target values
Bean for testing the client
Model representing a token response with several JWTs.
Model representing a JWT.
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.
Page model representing a collection of authenticators.
Model representing a page of
BaseAuthenticatorResources provided by the PUBLIC REST API.Model representing a page of
BaseAuthenticatorResources provided by the PUBLIC REST API.The API for making structured REST API calls to the "AuthenticatorsApi" endpoint.
The API for making structured REST API calls to the "AuthenticatorsApi" endpoint.
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.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.Wrapper for an object that does not itself implement
AutoCloseable, but needs to be closed in a different
kind of fashion.Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated.
Model for the data needed for auto login which is saved in the browser via a Cookie value.
Abstract base class for UUID entity resources.
Abstract base class for
file REST API resources.Abstract base class for
UUID entity REST API resources.Factory for creating state resolvers of views.
Helper bean for rendering avatar composite components.
Deprecated.
This is part of the old workflow engine.
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.Router for creating paths with axis-aligned lines.
Stores all the properties (
XPropertyEnum) of a form item and offers methods to access these properties.Model class for the properties of an authenticator of type
EAuthClientType.AZURE_AD.Deprecated.
use
AzureAdAuthenticatorProperties insteadBuilt-in default implementation for a plugin profile filter extensions for authenticators of type
EAuthClientType.AZURE_AD.Deprecated.
Use
AzureAdAuthenticatorProperties 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.Servlet context listener for executing common initialization and shutdown tasks for web applications with access to
the backend (MS and Fs with Inbox).
Extended JEE HTTP action adapter that adapts actions with location and content and redirects to default pages if no
content or location was given.
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.
The XfcJEESessionStore is a custom session store for JEE environments that allows for session renewal by changing the
session ID.
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.
List of requested resources.
Base resource for
authenticators for returning when collections of authenticators are
requested.Base resource for
authenticators for returning when collections of authenticators are
requested.The rendering type for this authenticator.
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 common properties used by do-until loop nodes.
Base class for common properties used by for-each loop nodes.
Base model representing a file attached to a form.
Base model representing a file attached to a form.
Base resource for
ProjectFile entities when a collection of files is requested.Base resource for
ProjectFile entities when a collection of files is requested.DTO for attachments of form records.
Base model representing an attachment of a form record.
Base resource of a
form record attachment for returning when collections of attachments are
requested.Base DTO for form record chats
Base model representing a chat of a form record.
Base resource of a
FormRecordChat when a collection of chats is requested.Base DTO for form records
DTO for messages of form records.
Base model representing a message of a form record.
Base resource of a
form record message for returning when collections of messages are
requested.Base DTO for form record message upload requests
Base model representing an upload request of a form record message.
Base resource of a
FormRecordMessageUploadRequest for returning when collections of upload requests are
requested.List of requested resources.
Base resource of a
form record for returning when collections of form records are requested.List of requested resources.
Base resource of a
form for returning when collections of forms are requested.Base resource of a
form for returning when collections of forms are requested.Base class for the model with additional data for the selected client form theme, such as the available parent form
themes.
Mixin for implementing
DefaultGroupSequenceProvider, with a little bit less boilerplate.Bean for editing workflow nodes for which a complex condition need to be configured, such as an if-else condition or
a while loop.
The properties model for workflow nodes for which a complex condition need to be configured.
The properties model for workflow nodes for which a complex do-until loop test need to be configured.
The properties model for workflow nodes for which a complex while loop test need to be configured.
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.
The custom files of the user portal.
Base resource for
UserPortalFile entities when a collection of files is requested in a
user portal context.List of requested resources.
Resource for
UserPortal entities.BaseUserProfileFileResource
Base class for user profile file resources.
Base class for common properties used by while loop nodes.
DTO for a base workflow response.
BaseWorkflowResponseResource
Base resource of a workflow response.
The type of the response.
DTO for workflow triggers.
List of workflow triggers associated with the form record.
Base resource of a
WorkflowTrigger when a collection of triggers is requested.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.A basic tree node.
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.
Interface representing binary multipart content.
A
predicate for checking whether a bit flag includes or excludes some or all of a given set of
flags.Builder for a
BitFlagSetPredicate.Class for storing informations and data for an mail-bodypart based on text
Builder for a multipart body that uses a
HttpRequest.BodyPublisher to represent the data.A
Control for editing boolean values that must conform to a IBooleanValueDescriptor.Base class for classes that require Bouncy Castle support.
View model for layout settings related to
boundary events in BPMN diagrams.Model for the flow graph BPMN editor component of the workflow designer.
Helper class for logic related to the Workflow BPMN export view.
An
extension element for BPMN that contains details regarding a WorkflowNode.An
extension element for BPMN that contains details regarding a WorkflowTrigger.Base class for raisable events in a
structured BPMN model part, see also
raisableErrors,
raisableEscalations, and
raisableSignals.Additional data for a
BpmnRaisable in a structured BPMN model part, see also
raisableErrors,
raisableEscalations, and
raisableSignals.Helper bean for rendering the
<xi:breadCrumb /> composite component.Resolves protocol entries for DAO bulk operations on entities.
The binary data of a file, along with some metadata such as the file name.
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.
Event that is fired when a user portal UI page is ready to render.
Provides access to common implementations of
ICardinalDirection2DMap.View model for double values associated with cardinal directions (north, east, south, west), e.g. paddings or
margins.
A custom implementation of the Quartz `JobFactory` that integrates with CDI (Contexts and Dependency Injection).
Makes each Dao instance from
DaoProvider available as a CDI bean.Backing bean for certificate autocomplete functionality.
Autocomplete component for selecting certificates by their subject RDN (Relative Distinguished Name).
View model of a certificate for the autocomplete component.
Mapper for
CertificateAutocompleteViewModel.Model class representing the base data of a certificate.
Represents a bundle of certificates, which may include an X.509 certificate and its corresponding private key.
A TrustManager that captures the certificate chain presented during trust validation.
Event representing changes to certificates, such as creation, update, or deletion.
Parameters for starting the creation process of certificates.
Common interface for interacting with the certificate creation process via the certificate creation wizard (dialog).
Bean for creating a new certificate.
Model class representing the base data of a certificate.
Represents the payload for a certificate expiration notification.
Necessary Details at certificate level.
Common interface for interacting with the certificate export process via the certificate export wizard (dialog).
Backing bean for certificate export.
Parameters for starting the export process of certificates.
A DTO that contains information about a certificate.
Implementation of the
ICertificateLocalizer.Common constants for the certificate management module.
Interface that encapsulates all certificate and key-related operations available within the XIMA formcycle
certificate module.
Event representing a request to reset the certificate cache.
Backing bean for selecting certificates UI component.
Query for selecting certificates by their subject within a defined scope.
Query for selecting certificates by their subject within a defined scope.
Query for selecting certificates by their usage subject within a defined scope.
Query for selecting certificates by their usage subject within a defined scope.
Defines the scope within which certificates can be selected.
Defines the scope within which certificates can be selected.
Defines the types of scopes within which certificates can be selected.
Defines the types of scopes within which certificates can be selected.
Bean for managing the system-wide certificate settings.
A bean interface for handling certificate trust prompts in a JavaServer Faces (JSF) application.
Bean for handling the certificate trust prompt dialog in the GUI.
A DTO that contains information about the usage of a certificate.
The usage type of certificate.
An interface for adapting certificate details to a format that can be used to identify users by their email
addresses and common name.
Locale specific view model for certificates.
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.
The model for the chats page which holds the data from the portal localizations.
Controller bean for chat template creation based on the content of the chat message editor in the inbox.
View model for a chip.
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.Implementation of the localizations for
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.
Helper class for working with
authentication clients within the
DAO.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
Entity model for a form theme.
API class for reading and writing
ClientFormTheme entities.The default implementation of
IClientFormThemeDao that can be accessed via DaoProvider.Entity model for the metadata of a file from a
ClientFormTheme.An ID for a
ClientFormThemeFile that uniquely identifies that file within a particular
ClientFormTheme.Entity model for the data of a file from a
ClientFormTheme.Handler implementation for reading and writing
ClientFormTheme entities.IEntityImportConfig implementation for ClientFormTheme.Model for the preferences related to the UI that lets the user manage and edit
client form
themes.POJO models that represents all usages of a form theme within a client.
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.View of a
LDAP connection that can be sent to the client.View of a
LDAP query that can be sent to the client.Authorization generator that restores the profiles client name if it contains any suffixes needed for direct clients.
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 model for the configuration UI for the project portal configurations.
View of a
ProjectResource that can be sent to the client.View of a
PromptConnectionData that can be sent to the client.View of a
PromptQueryData 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.
A message that is used to synchronize driver state across the cluster.
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.Event that is fired when a node joins the cluster.
Event that is fired when a node leaves the cluster.
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)
This class contains the view IDs of the backend views.
Constants for BPMN diagrams.
Deprecated.
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.A builder for a string of code points.
We use the monaco editor for editing JavaScript.
Represents a partition of two collections, where:
inBoth contains elements that are present in both collections
onlyInFirst contains elements that are only in the first collection
onlyInSecond contains elements that are only in the second collection
A single color for graphviz.
List of common
IColorFields.Constants with the
IColorField.getIdentifier() values for the ColorFields.A list of weighed colors, used e.g. for gradients.
Implements
IResourceDescriptor by combining several IResourceDescriptor.Enumeration for common types of aspect ratios.
Enumeration for common types of audio formats.
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.Enumeration for common types of effort levels.
Helper methods for
ICommonFileSystem.A builder for a file system volume.
Helper bean for working with form record message nodes / triggers in the workflow designer.
Enumeration for common types of image backgrounds.
Enumeration for common types of image formats.
JAX-RS provider for Jackson
ObjectMapper.Common
IJsonBuilder implementations for widely-used libraries.Implementation of
IJsonIterator for common types.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.Constants with common names for prompt input properties, see
computeQueryInput.Internal service for retrieving details regarding various common options for prompt configuration parameters.
Constants with common names for prompt output properties, see
computeQueryOutput.Enumeration for common types of prompt tasks.
A list of
IRecordValueDescriptor for common or shared model types independent of an action's specific type.Model class for the properties of authenticators that use redirection to an external IDP.
Enumeration for common types of transcription formats, when transcribing speech to text.
Enumeration for common types of audio formats.
Internal helper that provides various algorithms for modeling common scenarios in a BPMN model
created from a formcycle workflow.
Utility class for comparing comparable values.
Common helper for maintaining compatibility.
View model for layout settings related to
complex gateways in BPMN diagrams.Utility methods for working with
UIComponents.Composite implementation of
X509TrustManager that delegates trust checks to a list of underlying trust
managers.Predicate that combines multiple single conditions via a
EMultipleConditionCombinationType.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.
Identifier for database connections used by the system.
The type of TLS scope.
Represents the result of a TLS connection test, including the trust validation status and the certificate chain used
during the test.
Component class for the
<xp:connectTimeout /> component.Deprecated.
This is part of the old workflow engine.
Class for working with the
Content-Disposition.A simple builder for
ContentDisposition.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.
A contextual reference to a prompt object, without the scope ID.
Base class for controls (rows) of a dynamically generated form.
Can be used together with a <xi:convertible> component.
Model class holding the core menu entries of the backend (back-office) main menu.
Indicates that a form record could not be locked
A generic interface for objects that keep a count, using a value from a discrete domain.
Provides
counter placeholders.Methods for
Counters.A generic AJAX behavior event that is triggered when an item was inserted somewhere.
System update that creates all
IndirectClientAuthorizations.Deprecated.
Exceptions for expired credentials on a user profile.
Data transfer object for cron trigger information.
A thumbnail generator that scales down images to a defined width and height.
A builder for a thumbnail generator that scales down images to a defined width and height.
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.
CRUD = create, read, update, and delete
CRUD = create, read, update, and delete
A
CrudMapAdapter for an immutable map.A
CrudMapAdapter.SetLike for an immutable set.Enumeration of supported export formats for cryptographic keys and certificates.
Service for analyzing cryptographic files and data on the master server.
Common interface for interacting with the crypto import process via the crypto import wizard (dialog).
Bean for importing cryptographic credentials (certificates and keystores).
Utility class for handling the results of crypto file imports in the GUI.
Parameters for starting the import process of crypto files such as keystores or certificates.
Configuration settings for cryptographic operations.
Service interface for managing cryptographic settings related to key algorithms in the formcycle certificate module.
This class represents the specifications for various key algorithms used in the XIMA formcycle certificate module.
Static factory methods for different CSS syntax types.
Represents an analyzed CSS class.
A CSS color value, with optional transparency.
Constraint validation that may be applied to values of type
String.Defines several
CssColorString constraints on the same element.Validator implementation for the
CssColorString constraint.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.
Normalizer for CSS.
Options for processing CSS files, see
FormCssHelper.A builder for
CssProcessingOptions.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.
CSV format options used by
CsvSplitter and CsvFormatter.Formats character separated values with a certain set of options.
Wrapper class for CSV formats
Utility class for importing CSV files
Helper methods for CSV item sources of the for each loop in the workflow.
Wrapper class for CSV parser
Wrapper class for CSV printer
Wrapper class for CSV records
Splits a string with multiple values separated by a given character.
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.
A custom implementation of X509ExtendedKeyManager that loads and manages X.509 certificates and their corresponding
private keys from a KeyStore.
Resource for custom content
Deprecated.
Use
PluginMenuEntryView instead.Parts of the
WorkflowExternalState that is sent to the client.Exception thrown when a cycle exists in the parent-child hierarchy of form themes.
Listener for initializing the DAO context.
Mixin to simplify CRUD (create-read-update-delete) operations on entities implemented via the
DaoProvider
layer .LazyDataModel for IEntitys & use with DataTable.Factory for creating
PagedResults for DAO queries.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.
Provider for the database connections available in the current client during workflow editing and validation.
Configuration for database connection.
Event for when an entity was modified, either when it was created, updated, or deleted.
Deprecated, for removal: This API element is subject to removal in a future version.
Provider for the URL templates available during workflow editing and validation.
Deprecated.
use
DatabaseUtilsView model for layout settings related to
data stores in BPMN diagrams.Interface for session stores which grants access to data map
Represents the state of database encryption verification, including whether the encryption is valid and any
exceptions that occurred during the check.
Deprecated.
Manager for persistence resources such as DataSources and EntityManagerFactories.
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
Factory for
data stores.View model for layout settings related to
data stores in BPMN diagrams.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
Base data for database access entities.
Deprecated.
Bean für die Verwaltung von Verbindungen
Deprecated, for removal: This API element is subject to removal in a future version.
use
UpdateBean.getDbEncryption() insteadDeprecated, for removal: This API element is subject to removal in a future version.
use
SystemPersistenceManager insteadDeprecated.
Encryption and encryption migration is handled by the persistence module.
Enumeration of known Database Management Systems (DBMS).
Bean for handling db queries
Deprecated, for removal: This API element is subject to removal in a future version.
use
UpdateBean.getDbSettings() insteadDeprecated.
Interface for encrypting and decrypting values of type TUnencrypted.
Registry for
DbValueEncryptor implementations.System update that deactivates the NTLM configuration if it is active.
The API for making structured REST API calls to the "DefaultApi" endpoint.
The default implementation of an
ApiBundle that provides access to the individual APIs.The default implementation of an
ApiBundle that provides access to the individual APIs.The default implementation of an
ApiBundle that provides access to the individual APIs.The default implementation of an
ApiBundle that provides access to the individual APIs.The default implementation of an
ApiBundle that provides access to the individual APIs.The default implementation of an
ApiBundle that provides access to the individual APIs.The default API client that is responsible for sending REST-like calls to an API endpoint and
also takes care of serialization and deserialization.
The default API client that is responsible for sending REST-like calls to an API endpoint and
also takes care of serialization and deserialization.
The default API client that is responsible for sending REST-like calls to an API endpoint and
also takes care of serialization and deserialization.
The default API client that is responsible for sending REST-like calls to an API endpoint and
also takes care of serialization and deserialization.
The default API client that is responsible for sending REST-like calls to an API endpoint and
also takes care of serialization and deserialization.
The default API client that is responsible for sending REST-like calls to an API endpoint and
also takes care of serialization and deserialization.
Default implementation of a
ApiInvocation which simply delegates to the ApiClient.Default implementation of a
ApiInvocation which simply delegates to the ApiClient.Default implementation of a
ApiInvocation which simply delegates to the ApiClient.Default implementation of a
ApiInvocation which simply delegates to the ApiClient.Default implementation of a
ApiInvocation which simply delegates to the ApiClient.Default implementation of a
ApiInvocation which simply delegates to the ApiClient.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.POJO implementation of a
ICreateNewFormRecordChatRequest with a builder.Builder for a
ICreateNewFormRecordChatRequest.Enumeration of
TemporalQuerys for a ZonedDateTime that defaults to a certain value when a
TemporalField is missing in the TemporalAccessor.Implementation of
IElFinderFileSystemOptionsProvider that provides defaults for all settings.A
IElFinderHashCodec that uses the default implementation as detailed by the elFinder docs.General exception handler.
Default implementation
IExecutePromptQueryParams with a builder.Builder for
DefaultExecutePromptQueryParams.Default implementation
IExecutePromptQueryRetVal with a builder.Builder for
DefaultExecutePromptQueryRetVal.Simple POJO implementation of an
IExtendedFulfillRequestedUploadRequest with a builder.Builder for a
DefaultExtendedFulfillRequestedUploadRequest.Simple POJO implementation of an
IExtendedPostFormRecordMessageRequest with a builder.A simple builder for a
IExtendedPostFormRecordMessageRequest.Creates 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 dataThe default files of the user portal.
POJO implementation of a
IFormDataUpdateUploadRequest with a builder.Builder for a
IFormDataUpdateUploadRequest.Default 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.Simple POJO implementation of
IFormRecordChatReference.Default POJO implementation of
IFormRecordMessageAttachmentData.Default POJO implementation of
IFormThemeChain.Default implementation of
IFormValuePostProcessorRetVal.Default
form value replacer implementation provided by formcycle that is always available.Simple POJO implementation of
IFulfillRequestedUploadRequest with a builder.Builder for the data needed to fulfill a pending upload request.
Builder for an
IFulfillRequestedUploadRequest.Default POJO implementation of
IFulfillRequestedUploadResponse.Default identity check handler that executes a Java method if the tokens match.
The default links of the user portal.
Default converter for the tagify component.
The default localizations of the user portal.
Default POJO implementation of
ILocalizationViewModel that uses a default entry type, if you do not need a
custom entry type.Default POJO implementation of
ILocalizationViewModelEntry.Default implementation for sending mails via smtp
Deprecated.
Deprecated.
A JaxRS context resolver that adds a basic
ObjectMapper for serialization and deserialization.A JaxRS context resolver that adds a basic
ObjectMapper for serialization and deserialization.A JaxRS context resolver that adds a basic
ObjectMapper for serialization and deserialization.A JaxRS context resolver that adds a basic
ObjectMapper for serialization and deserialization.A JaxRS context resolver that adds a basic
ObjectMapper for serialization and deserialization.A JaxRS context resolver that adds a basic
ObjectMapper for serialization and deserialization.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.POJO implementation of
IPluginFormResourceDescriptor with a builder.A builder for a
DefaultPluginFormResourceDescriptor.Default POJO implementation of
IPluginFormThemeRetVal with a builder.Simple builder for a
DefaultPluginFormThemeRetVal.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.POJO implementation of
IPostFormRecordMessageRequest with a builder.Builder for
DefaultPostFormRecordMessageRequest.Default POJO implementation of
IPostFormRecordMessageResponse.Default implementation of
IPresetTemporalFormatter that provides a builder for formatting temporal objects
(like dates and times) into localized strings using predefined styles.Default implementation of
IProjectRecordsParameters.Builder for
DefaultProjectRecordsUpdateParameters.A builder for a
IPromptComputeQueryInputRetVal.Default implementation of
IPromptComputeQueryOutputRetVal with a builder.A builder for a
IPromptComputeQueryOutputRetVal.Default implementation of
IPluginGenericCustomGUI that uses the
XHTML and
main bean class of the prompt service handler; and allows
for additional unmanaged beans to be specified.Default implementation
IPromptConnectionExportSpec with a builder.A builder for a prompt connection export specification.
Default implementations of
IPromptExecutionContext.A builder for a
IPromptExecutionContext.Default implementation of
IPromptExecutionParams with a builder.Builder for
DefaultPromptExecutionParams.Default implementations of
IPromptExecutionReplacer.Default implementations of
IPromptExecutionReplacerContextResolver.Default implementations of
IPromptExecutionReplacerEscaper.Default implementation of
IPromptExecutionReplacerSettings with a builder.Default implementation of
IPromptExecutionRetVal with a builder.A builder for
DefaultPromptExecutionRetVal.Default implementations of
IPromptFileStorage.Default implementation of
IPluginGenericCustomGUI that uses the
XHTML and main
bean class of the prompt service handler; and allows for additional unmanaged beans to be specified.Default implementation of
IPromptQueryExportAnalysisSpec.A builder for creating prompt query export analysis specifications.
Default implementation
IPromptQueryExportSpec with a builder.A builder for a prompt query export specification.
Default implementation
IPromptQueryImportSpec with a builder.A builder for a prompt query import specification.
Default implementation of
IPromptComputeQueryInputRetVal with a builder.A builder for a
IPromptComputeQueryInputRetVal.Default implementation of
IPromptComputeQueryOutputRetVal with a builder.A builder for a
IPromptComputeQueryOutputRetVal.Default implementation of
IPromptQueryRequestObject with a builder.A builder for a
prompt query request object.Default implementation of
IPromptQueryResponseObject with a builder.A builder for a
prompt query response object.Default implementation of
IPromptReference with a builder.A builder for
DefaultPromptReference.Default implementation of
IPromptStoredData.Default implementation of
IPromptTestConnectionParams with a builder.Builder for
IPromptTestConnectionParams.Default POJO implementation of
IPromptTestConnectionRetVal.Default POJO implementation of
IReferencableFormTheme.POJO implementation of
IRequestUploadData with a builder.A builder for
IRequestUploadData.Default implementation of
IRetrieveConnectionModelParams with a builder.A builder for
DefaultRetrieveConnectionModelParams.Default implementation of
IRetrieveConnectionModelRetVal with a builder.A builder for
DefaultRetrieveConnectionModelRetVal.Default implementation of
IRetrieveQueryModelParams with a builder.A builder for
DefaultRetrieveQueryModelParams.Default implementation of
IRetrieveQueryModelRetVal with a builder.A builder for
DefaultRetrieveQueryModelRetVal.Default implementation of
ISerializableFile with several static factory methods for creating instances.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
ITestPromptConnectionParams with a builder.A builder for
DefaultTestPromptConnectionParams.Default implementation of
ITestPromptConnectionRetVal with a builder.Default POJO implementation of
ITriggeredWorkflowExecutionResult.Default implementation of
IAuthenticatorConfigRenderer for authenticators that use an input mask with
username & password fields.Implementation of
IValueDescriptorTypeCoercer with the default coercion logic.A
IValueStructureAccessor for raw Java objects, i.e.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.Similar to a
FileInputStream, but deletes the file when the stream is closed.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.An
EditableControl that uses an IValueDescriptor to coerce values.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.
Bean that provides additional functionality for the placeholder dialog in the designer.
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.
DetailedAuthenticatorResource
Detailed resource for
authenticators for returning when a single authenticator is
requested.The rendering type for this authenticator.
Detailed model of a file attached to a form.
Detailed resource for
ProjectFile entities when a single file is requested.Detailed model of an attachment of a form record.
Detailed resource of a
form record attachment for returning when a single attachment is requested.DTO for form record chats.
Detailed model representing a chat of a form record.
Detailed resource of a
FormRecordChat when a single chat is requested.DTO for detailed form records.
DTO for form record messages.
Detailed model representing a message of a form record.
Detailed resource of a
form record message for returning when a single message is
requested.DTO for form record message upload requests.
Detailed model of a message upload request of a form record.
Detailed resource of a
FormRecordMessageUploadRequest for returning when a single upload request is
requested.DetailedFormRecordResource
Detailed resource of a
form record for returning when a single form record is requested.DetailedFormResource
DetailedFormResource
Detailed resource of a
form for returning when a single form is requested.Detailed resource of a
form for returning when a single form is requested.DetailedUserPortalFileResource
Detailed resource for
UserPortalFile entities when a single file is requested in a user
portal context.DetailedUserPortalResource
Resource for
UserPortal entities.Resource aggregating the default files of the user portal.
Resource aggregating the default links of the user portal.
Resource aggregating the default localizations of the user portal.
Resource for the form records page of the user portal.
Resource for the forms page of the user portal.
Resource for the general localizations of the user portal.
Resource for growl notifications of the user portal.
Resource for the login page of the user portal.
Resource for the messages page of the user portal.
Resource for the user header of the user portal.
Resource for the welcome page of the user portal.
The login form layout type of the user portal.
DetailedUserProfileResource
Resource of a
UserProfileResource aggregating the default files of the user profile.
DetailedWorkflowTriggerResource
Detailed resource of a
WorkflowTrigger when a single trigger is requested.Servlet context listener that checks whether
javax.faces.PROJECT_STAGE) is set to
ProjectStage.Development.A resource meant only for development.
Deprecated.
Use
DevResourceFiler 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.
Event that is fired when a user portal UI page was opened that is associated with a particular portal and the data
for that portal was loaded.
Utility class for digest operations.
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.A directed edge statement.
A directed graph.
A sub graph statement with directed edges.
A sub graph expression with directed edges.
Default POJO implementation of a
IDiscriminatedUnionMember.A
Control for selecting the discriminator of a union value.Authentication config wrapper for a distinct user.
Service providing base functionality of the REST API
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.
A list of doubles.
The
INodeExecutionData published by the EWorkflowNodeType.FC_DO_UNTIL_LOOP.Parameters for the local backup download, see
FormBackupHelper and
FormDesignerBackupBean.getLocalBackup().Manager for handling downloads of public form resources.
Model that stores the available prototypes for the workflow elements.
Backing bean for the driver administration.
Information about a database driver for event purposes.
Defines actions for which permissions can be checked regarding driver management.
View model representing information about a JDBC driver.
Mapper interface for converting between IDriverInfo and DriverViewModel.
Factory for creating dummy
authenticator properties for use by pac4j clients.Builder for creating (mock)
pac4j profiles.Helper for creating a user with a profile, identity and email.
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.Extension of the
pac4j Clients, that provide the authentication clients for a dynamic list of
clients using the client cache.An access property describes the permissions a formcycle user is granted.
Categories of the admin dashboard, used by IMenuEntryModel.
Resultat eines Workflow-Schrittes.
Enumeration for the side of the flow where a label should be aligned, used by
IWorkflowBpmnLayoutAlignOnFlowSideConfigurator.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 possible values for the
dir attribute.Graphviz arrow head shapes.
The type of assignee.
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.
Enumeration of the different types of attribute statements in a graph dot graph.
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.
Enum for the different types of authentication renderers.
A
IWorkflowBpmnPointsAccessor that assumes a rectangular shape whose width and height equals the width and
height of the bounding box.The polarity or direction of an axis in a coordinate system.
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.Enumeration for the direction hint when computing the layout of a
BpmnLabel for the name
of a BpmnElement.Enumeration for the direction hint when computing the layout of a
BpmnLabel for a TextAnnotation that
annotates a BpmnElement.Enumeration for the font size unit in BPMN diagrams.
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 with the cardinal directions in 2D space, corresponding the 4 main directions of a compass.
An enumeration representing the two dimensions in a 1D cartesian coordinate system.
An enumeration representing the two dimensions in a 2D cartesian coordinate system.
An enumeration representing the two dimensions in a 3D cartesian coordinate system.
Enum representing the steps in the certificate creation process.
The source of the certificate, which indicates how the certificate was created or obtained.
The type of trusted certificate.
The usage type of certificate.
Enumeration representing the units of validity for a certificate.
Enumeration of the different ways to change a form's availability, used by the workflow action.
Enumeration of the possible ways how an action of type
FC_CHANGE_FORM_RECORD_CHAT_ACTIVENESS can change the active state of a form record chat.A
IWorkflowBpmnPointsAccessor that assumes a circular shape whose diameter equals the width and height of the
bounding box.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.
Possible values for the
clusterrank attribute.Enumeration of available color palettes for the web.
Graphviz color names for the SVG scheme.
Graphviz color names for the X11 schema.
Representing label options for columns during form record export
Common implementations of
IAttachmentSearchOptions.Common implementations of
IFileSearchOptions.Enumeration of the compass point types in a graph dot graph.
Enumeration with the possible values for how files are named when put into a ZIP archive.
Enum der Verbindungs-Status
Predefined alignments for aligning boxes inside a container.
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
Enum describing the type of a cryptographic file element.
Enumeration representing different types of CSR (Certificate Signing Request) file formats.
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.
An attribute list for edges.
A
IWorkflowBpmnAlignmentSelector that select a point on the edge in the given direction of an item's bounding
box.A
Control that allows editing a value via some input mechanism.Graphviz styles for edges.
Enumeration of the edge types of a graph dot graph.
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.
Enumeration of well-known elfinder error codes for the elfinder file manager.
Format of mail as file for archive.
Types of mail body sending format
Presets for
end user states for the workflow designer.Enum representing the default type for end user states.
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.
Enum representing the type of external user reference.
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_RECORD_CHAT_ACTIVENESS
action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_CHANGE_FORM_RECORD_CHAT_ACTIVENESS
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.Updates for the
FcCreateTextFileProps model class.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.Updates for the
FcDecodeBase64Props model class.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_DO_UNTIL_LOOP action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_DO_UNTIL_LOOP 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.Deprecated.
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 soft error codes for the
EWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATS action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_EXPORT_TO_PERSISTENCE action.Updates for the
FcExportToPersistenceProps model class.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.Updates for the
FcExportToXmlProps model class.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.Updates for the
FcFillPdfProps model class.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.Updates for the
FcFillWordProps model class.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_FILL_WORD action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_FOR_EACH_LOOP action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_FOR_EACH_LOOP 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.Updates for the
FcProcessLogPdfProps model class.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_PROMPT_QUERY action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_PROMPT_QUERY action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_PROVIDE_RESOURCE action.Updates for the
FcProvideResourceProps model class.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_DAVEnumeration of the possible error codes for the
EWorkflowNodeType.FC_SEND_FORM_RECORD_MESSAGE action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_SEND_FORM_RECORD_MESSAGE action.Types of formcycle servers.
Enumeration of the possible error codes for the
EWorkflowNodeType.FC_SET_FORM_RECORD_PASSWORD action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_SET_FORM_RECORD_PASSWORD action.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_WHILE_LOOP action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_WHILE_LOOP action.Enumeration of the possible error codes for the
EWorkflowNodeType.FC_WITH_FORM_ELEMENT_CONTEXT action.Enumeration of the possible soft error codes for the
EWorkflowNodeType.FC_WITH_FORM_ELEMENT_CONTEXT action.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 different error types that can occur when handling a
IFileProvision.Enumeration of the possible request source that may trigger a backup detect event.
Presets for the
FlowchartToBpmnConverterSettings and WorkflowBpmnLayoutSettings.Possible ways of how the flow graph layout is computed for purposes of visualization.
Enumeration with the possible sources of items over which the built-in for-each loop workflow node can iterate.
Deprecated.
Indicates how existing files of an upload element should be handled when updating the files of an upload element.
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
Enumeration of the possible ways to select the user of the chat to which to send a message.
Enum for regulating access to form records
The type of the form record history.
Enum representing the default message contexts for form records.
Enum providing the default sender contexts.
Enum for displaying different kinds of quartz jobs for form records.
Basic types of form record queries.
Enum representing the default submit contexts for form records.
FormVersion-Komandos
Indicates the source of a form resource.
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.
UI mode for editing a
client form theme.Controls the behavior when a
IFormTheme and its parent both contain a file with the same name.Enumeration of the possible types of
FormThemeReference.Common resource contexts for form themes, see
IFormTheme.Von Formcycle unterstützte Formulartypen.
FormVersion aktionen einer FormVersion
Freigabe-Status einer FormVersion
Typ des Freigabemechanismus eines Mandanten
Enumeration of the type of a graph dot graph.
Enum representing hash algorithms.
Pre-defined HttpClients for executing HTTP requests.
Defines the transport type to use for HttpClients to execute 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.
Pre-defined HttpClients for executing HTTP requests.
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.
Enumeration that defines the methods available for a user to define a JSON schema for the prompt response.
Used by
JsonSchemaOutputObjectProperty.Enumeration of JSON schema versions.
Enum representing the options for defining an LDAP user filter for KERBEROS authentications.
The algorithm used for generating a key pair.
Traits to filter key store entries by in the administration view.
The type of keystore entry.
Enumeration of the values for the label location attribute.
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.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.Deprecated.
POJO implementation of
IElementWithTask.Methods for
IElEvaluator, such as creating a new evaluator or a builder for an evaluator.A builder for an
ElEvaluators.Exception raised when a request to the elfinder connector could not be handled.
Represents a client error.
Represents a server error.
A thumbnail generator for the elFinder file manager.
Base builder for generating thumbnail URLs via the dynamic resource servlet and handling requests to that
servlet.
A builder for a thumbnail request handler for file system entries from a
ICommonFileSystem, with initial
data from a IFileEntity stored in a database.A builder for a URL creator that generates URLs for thumbnails of file system entries from a
ICommonFileSystem, with initial data from a IFileEntity stored in a database.Simple model for the default file hash used by the elfinder file manager.
Model and utility class for the upload mime configuration of the ElFinder file manager.
First order to check for mime types, corresponding to the
firstOrder property of the ElFinder upload mime
configuration.Enumeration of the available license check type.
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.
The public resource enum type of
EInputClientLayout.Possible positions for the login notice on the login screen.
Enum representing the state of user credentials logins.
Enum representing log levels
Deprecated.
An email address value object.
An email address value object.
Enumeration of possible authentication methods.
Deprecated.
Use
EMailSecurityType instead.Specifies templates for email security configurations, combining
security types with
specific usage modes (like signing only, encryption only, or both).Specifies the available types of email security for message transmission.
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.
Deprecated.
Enumeration of default options for the monaco code editor.
Deprecated, for removal: This API element is subject to removal in a future version.
The system emf is now managed by
SystemPersistenceManager.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.
Represents an encrypted key store containing certificates and private keys.
Generates new HTML templates for authentication
View model for layout settings related to
end events in BPMN diagrams.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.Base interface for a collection of API calls under the same category.
Base interface for a collection of API calls under the same category.
Base interface for a collection of API calls under the same category.
Base interface for a collection of API calls under the same category.
Base interface for a collection of API calls under the same category.
Base interface for a collection of API calls under the same category.
Represents an API call made from a certain
EndpointCategory.Represents an API call made from a certain
EndpointCategory.Represents an API call made from a certain
EndpointCategory.Represents an API call made from a certain
EndpointCategory.Represents an API call made from a certain
EndpointCategory.Represents an API call made from a certain
EndpointCategory.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.View model for the configuration UI for the end user settings of a
form.Entity model for end user states.
View model for the workflow designer, for the
end user state configuration of a
workflow stateValidation groups for the
EndUserStateConfigViewModel.The default implementation of
IEndUserStateDao that can be accessed via DaoProvider.DTO for form record states.
DTO for form record history entries.
Implementation of the localizations for
EndUserState entities.View model for editing localized messages of a
end user state.Extends the
DefaultLocalizationViewModelEntry with additional methods for accessing end user state specific
properties.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.
Graphviz styles for nodes.
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
Deprecated.
Use
ProjectExportService instead for project exportsFactory for creating the export files for entities during serialization
Helper class for generating
StreamedContent from entitiesA
file system implementation for entities that represent the files in the file system and
are persisted in some kind of persistence layer, such as for example JPA entities.A builder for configuring a new
EntityFileSystem.A builder for configuring a new
EntityFileSystem.A builder for configuring a new
EntityFileSystem.A builder for configuring a new
EntityFileSystem.POJO view for the
AttributeSelectCriteriaManager when selecting only the ID of an entity.A POJO for the ID and locking version of an entity.
Deprecated.
Result of a migration of
IEntityImportConfig instances, see EntityImportMigrator.Deprecated.
In the future each domain module will provide its own way of importing and exporting entities.
Deprecated.
Use specialised importers like the
ProjectImporter insteadHelper class for importing entities
Helper methods for migrating old
IEntityImportConfig to their corresponding new versions.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.Annotation for entity classes with additional details how to migrate instances of the entity.
Used by
EntityMigrationSettings, includes a reason for why the entity is ignored during migration.A custom migrator to apply to each instance of an entity to migrate.
Custom strategy when migrating entities.
Model class for referencing an entity either by
UUID or nameA
IDaoActionListener for checking whether an entity is still referenced by another entity, and preventing the
deletion of said entity if it is.Deprecated.
Class for (de-)serializing entities
Deprecated.
Enumeration of formcycle entities for referencing purposes.
Deprecated.
Use
DefaultEntityReader or DefaultEntityWriter instead.Combines a scope with a list of file system entries, intended to be used with e.g.
Deprecated.
Not used and not needed.
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.Enumeration for the values of the
ordering attribute, which constrains the left-to-right ordering of
node edges.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.A placeholder insertion hint describes the way a placeholder prefers to be inserted into input components (if it is
supported by the respective input component).
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.
Presets styles for formatting temporal objects like dates and times, see
IPresetTemporalFormatter.Enumeration with the primary intercardinal directions in 2D space, corresponding to the four main intercardinal
directions of a compass.
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.
Enumeration that defines the multiplicity of file input parameters in a prompt query configuration, e.g. how many
files are allowed.
The object-fit property defines how an image should be resized to fit its canvas.
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.
The public resource enum type of
EAuthRenderType.The public resource enum type of
EAuthRenderType.Enum representing the public type for end user states.
Enumeration of the types of resource that can be returned by the public resource servlet.
Public view definitions that don't require an authenticated in user.
Colors from https://quasar.dev/style/color-palette.
Enumeration of the values for the
rankdir attribute.Enum representing error handling modes for remote update of data sources.
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.
Model for the error page mapping, i.e. status code 404 to the URL https://example.com/404.
Model for the error pages that should be shown when the app encounters an error.
Registry for all errors.
Bean that wraps some basic error information to be delivered as error response by the REST API.
The allowed same-site cookie attribute values.
Enum specifying the type of the SAML entity ID.
This is an enum that contains the variants of the functions for a frontend server and is used on the configuration
interface of the frontend server.
An enumeration of the available HTTP methods for a HTTP servlet.
Enumeration for how to determine the password for the "set form record password" action.
Shapes for graphviz nodes.
Enumeration of the modes for the
showboxes attribute.Signature types enum.
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.Enumeration of the possible ways to select an item from a list of items.
Standard graphviz attribute names.
Enumeration with common types for how nodes can transfer control to other nodes.
Type of reference to a state
Deprecated.
Use the new workflow engine, e.g.
Enumeration of how to string are compared to another.
Graphviz styles for graphs and sub graphs.
Enum representing the state a
UserCredentials may be in.The type of the built-in form theme.
Enum representing types of system informationView definitions that require an authenticated in user with system role.
POJO models for an ETag that can be exchanged via HTTP requests for cache control etc.
Creates ETags for various objects, such as entities or plugins.
Represents a request for a tagged resource.
Represents a resource cached via the ETag mechanism.
Matcher for the different states of an
ETagResource.An
ETagResource that represents a resource that was modified.An
ETagResource that represents a resource that was not found.An
ETagResource that represents a resource that was not modified.Utility for working with the ETag HTTP caching mechanism.
Some page formats that might be passed as conversion parameters (see the particular converter implementation for
supported values).
Type of a form element template shown in the designer.
Dieser Enum listet alle möglichen Nachrichtencodes auf, die Textbausteinen zugeordnet werden können
How to treat files with empty or blank content when such a file is set.
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 representing the types of time event expressions for a BPMN
timer event.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.
Enumeration for the unit of the read and connect timeout of the HTTP request action.
Enum for possible intents of an database transaction.
A
ITreeAccessor for treating WorkflowNodes as a tree, so that they can be used with the execution
analyzer.A
IWorkflowBpmnPointsAccessor that assumes a rhomboid shape (upright diamond) whose width and height equals
the width and height of the bounding box.Deprecated.
Enumeration of the possible access types for user invocation workflow triggers.
Enumeration representing the different tabs available in the User Portal Form Record view.
Generic views for the user portal that do not require any specific context.
Views for the user portal that require a portal alias to be specified.
Enum for the tabs in the user portal UI.
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.
View model for layout settings related to
event based gateways in BPMN diagrams.Interface for an event bus that distributes events across a cluster and to frontend servers.
POJO implementation of
IEventExecutionResult.Event handler responsible for delegating events posted over the API.
View model for layout settings related to various
events in BPMN diagrams.Helper for locating the workflow tasks that apply to a certain event.
Klasse zum Mappen von hinterlegten Verarbeitungsnamen zur entsprechenden Klasse
Enumeration of view directions in 2D space.
View enum for issues that a key store entry can have.
Enum representing the types of keystore entries that can be viewed in the GUI.
Deprecated.
User
IView insteadEnumeration with well-known purposes for having a
virtual flow graph node in a control
flow graph.Color 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 representing the style of connections in a BPMN diagram created by the workflow engine.
Defines how line breaks are handled when converting a workflow to a BPMN diagrams.
Enumeration how the
WorkflowBpmnTextLayoutSettings.maxHeight() is interpreted.Enumeration of built-in categories for workflow nodes and triggers.
A single workflow event may trigger multiple tasks, which are executed in order.
A list of built-in workflow types.
Enumeration of
WorkflowStates types that may be treated specially by the system.Source of textual data for workflow actions.
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
View model for layout settings related to
exclusive gateways in BPMN diagrams.POJO data model for the push event beans.
Indicates that execution of a workflow node was aborted.
Exception thrown when executing a prompt query could not be executed for an unknown reason.
Builder for a
ExecutionFailedException.Enum for the different types of configuration files used by formcycle.
Contains mappings from JVM argument and environment variable names to already existing configuration keys.
external parameter groups.
Upload postprocessor implementation that adjusts the orientation and clears the metadata of supported images.
Runtime exception, thrown in case of errors when processing EXIF metadata.
Deprecated.
Deprecated.
Deprecated.
In the future each domain module will provide its own way of importing and exporting entities.
Deprecated.
Deprecated.
Utility class for unzipping formcycle export files
POJO helper class for the appointment free slot query result builder.
Extended Facebook profile creator that adds additional attributes to the profile.
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 HttpServletResponseWrapper for
IExtendedFormRenderContext that delegates all methods to the wrapped instance.Context of a form request extended with
HttpServletRequest and HttpServletResponseExtended profile creator for OAuth2 that adds additional attributes to the profile and silences an annoying info log
message.
Extended profile creator for OpenID Connect that silences an annoying error log message.
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.
Represents a reference to an external user.
Default POJO implementation of
IExtractSearchTermsParams.Der Enum Zugriffsrechte dient dazu die Rechte eindeutig zu identifizieren
Model class for accessing the properties of an authenticator of type
EAuthClientType.FACEBOOK in a structured
manner.Token adapter for Facebook.
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.
Handles unauthorized REST API responses from the server by redirecting to the login page.
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.Helper class to update JSON objects between different versions.
A JAKARTA bean validation API message interpolator for formcycle that combines different built-in resource bundles as
well as resource bundles provided by plugins.
BPMN modeler for nodes of type break.The
INodeHandler for nodes of type EWorkflowNodeType.FC_BREAK.Model class for the return action (
EWorkflowNodeType.FC_BREAK).BPMN modeler for triggers of type catch error.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_CATCH_ERROR.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_CATCH_ERROR.A mail security certificate provider that retrieves certificates from the central FC Certificate service.
Exception thrown by the certificate implementation.
Exception thrown by the certificate implementation.
BPMN modeler for nodes of type change form availability.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).Helper bean for working with the change form record chat activeness node in the workflow designer.
BPMN modeler for nodes of type
change form record chat activeness.Handler for executing a workflow action of type
EWorkflowNodeType.FC_CHANGE_FORM_RECORD_CHAT_ACTIVENESS.The
INodeHandler for nodes of type change form
record chat activeness.Model class for the log entry action (
EWorkflowNodeType.FC_CHANGE_FORM_RECORD_CHAT_ACTIVENESS).BPMN modeler for nodes of type change
form value.Handler for executing a workflow node of type
EWorkflowNodeType.FC_CHANGE_FORM_VALUE.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.BPMN modeler for nodes of type change
state.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.BPMN modeler for nodes of type compress
as ZIP.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.BPMN modeler for nodes of type continue.The
INodeHandler for nodes of type EWorkflowNodeType.FC_CONTINUE.Model class for the return action (
EWorkflowNodeType.FC_CONTINUE).BPMN modeler for nodes of type copy
form record.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).BPMN modeler for nodes of type counter.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.BPMN modeler for nodes of type create
text file.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.BPMN modeler for nodes of type decode
base64.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).BPMN modeler for nodes of type delete
attachment.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.BPMN modeler for nodes of type delete
form record.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.BPMN modeler for nodes of type doi init.Handler for executing workflow actions of type
EWorkflowNodeType.FC_DOI_INIT.Model class for the workflow action that initializes the Double-Opt-In process.
BPMN modeler for triggers of type double opt-in verified.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_DOI_VERIFIED.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_DOI_VERIFIED.Bean for editing FORMCYCLE
EWorkflowNodeType.FC_DO_UNTIL_LOOP nodes.BPMN modeler for nodes of type do-until
loop.Handler for executing a workflow node of type
EWorkflowNodeType.FC_DO_UNTIL_LOOP.The
INodeHandler for nodes of type EWorkflowNodeType.FC_DO_UNTIL_LOOP.The properties model for workflow nodes of type
EWorkflowNodeType.FC_DO_UNTIL_LOOP.Exception thrown when there is an issue with the JDBC driver.
Bean with additional logic for controlling the
EWorkflowNodeType.FC_EMAIL action.BPMN modeler for nodes of type email.Exception thrown for email related errors.
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.BPMN modeler for nodes of type empty.The
INodeHandler for nodes of type EWorkflowNodeType.FC_EMPTY.Model class for the email workflow action (
EWorkflowNodeType.FC_EMPTY).BPMN modeler for nodes of type encode
base64.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).Hibernate UserType that maps a byte array field to an encrypted LOB field in the database.
Deprecated.
Use
FcEncryptedBinaryType directly.Hibernate UserType that maps an Integer field to an encrypted String field in the database.
Deprecated.
Use
FcEncryptedIntegerType directly.Hibernate UserType that maps a String field to an encrypted String field in the database.
Deprecated.
Use
FcEncryptedStringType directly.Base interface for all custom Hibernate types for encryption.
BPMN modeler for nodes of type experiment.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.BPMN modeler for nodes of type export form record chats.Handler for executing a workflow action of type
EWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATS.The
INodeHandler for nodes of type EWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATS.Model class for the workflow action (
EWorkflowNodeType.FC_EXPORT_FORM_RECORD_CHATSBPMN modeler for nodes of type export to persistence.Handler for executing a workflow action of type
EWorkflowNodeType.FC_EXPORT_TO_PERSISTENCE.The
INodeHandler for nodes of type export to persistence.Controller for the
EWorkflowNodeType.FC_EXPORT_TO_XML action.BPMN modeler for nodes of type export to
xml.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.BPMN modeler for nodes of type fill pdf.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).BPMN modeler for nodes of type fill word.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).Bean for editing FORMCYCLE
EWorkflowNodeType.FC_FOR_EACH_LOOP nodes.BPMN modeler for nodes of type for each
loop.Handler for executing a workflow node of type
EWorkflowNodeType.FC_FOR_EACH_LOOP.The
INodeHandler for nodes of type EWorkflowNodeType.FC_FOR_EACH_LOOP.Utility class for resolving an item list for the for-each loop of type
EForEachLoopItemListSource.ATTACHMENTS.Utility class for resolving an item list for the for-each loop of type
CHARACTER_SEPARATED_VALUES.Utility class for resolving an item list for the for-each loop of type
ROWS_OF_CHARACTER_SEPARATED_VALUES.An empty item list for the items resolvable by a
FC_FOR_EACH_LOOP.Utility class for resolving an item list for the for-each loop of type
FIELD_VALUES.Utility class for resolving an item list for the for-each loop of type
EForEachLoopItemListSource.FILES.Utility class for resolving an item list for the for-each loop of type
JSON_VALUE.The properties model for workflow nodes of type
EWorkflowNodeType.FC_FOR_EACH_LOOP.Utility class for resolving an item list for the for-each loop of type
FORM_FIELD_REPETITIONS.A
Converter for a FormElementModel that is used on the inbox and data table configuration page.Bean for the properties panel of
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_POSTED
trigger workflow elements.BPMN modeler for triggers of type
form record message posted.The
INodeHandler for triggers of type EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_POSTED.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_POSTED.BPMN modeler for triggers of type
form record message upload request
fulfilled.The
INodeHandler for triggers of type
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_UPLOAD_REQUEST_FULFILLED.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_UPLOAD_REQUEST_FULFILLED.BPMN modeler for triggers of type
form submit button.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_FORM_SUBMIT_BUTTON.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_FORM_SUBMIT_BUTTON.Exception for Hibernate related issues.
BPMN modeler for nodes of type post
request.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.BPMN modeler for nodes of type
import form value from xml.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).BPMN modeler for triggers of type invitation error.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_INVITATION_ERROR.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_INVITATION_ERROR.BPMN modeler for triggers of type invitation sent.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_INVITATION_SENT.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_INVITATION_SENT.Custom exception class for errors within the LDAP module.
Bean with additional logic for controlling the
EWorkflowNodeType.FC_LDAP_QUERY action.BPMN modeler for nodes of type ldap query.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).BPMN modeler for nodes of type log entry.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).BPMN modeler for triggers of type manual.The
INodeHandler for triggers 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
FCMessageBPMN modeler for nodes of type move form record to inbox.Handler 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.BPMN modeler for nodes of type sequence.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.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
BaseMultipleConditionProps.getConditions().Defines several
FcMultipleConditionsUniquelyNamed constraints on the same element.Constraint annotation validator for
FcMultipleConditionsUniquelyNamed.Exception thrown by notifications management domain.
Base exception for persistence related issues.
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.
BPMN modeler for nodes of type process
log pdf.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).Exception thrown during project export operations.
Base exception for the project management domain.
A special type of
FcPromptException that is thrown by services when the user lacks permission to perform a
certain action.Base exception for all exception raised by the prompt API.
A special type of
FcPromptException that is thrown by the IPromptManagementService when creating,
updating, or deleting prompt objects fails.Bean with additional logic for controlling the
EWorkflowNodeType.FC_PROMPT_QUERY action.BPMN modeler for nodes of type prompt
query.Handler for executing a workflow action of type
EWorkflowNodeType.FC_PROMPT_QUERY.The
INodeHandler for nodes of type EWorkflowNodeType.FC_PROMPT_QUERY.Constraint validation that may be applied to
IPromptQueryWithParameters.Defines several
FcPromptQueryParameters constraints on the same element.Constraint annotation validator for
FcPromptQueryParameters.Model class for the database statement action (
EWorkflowNodeType.FC_PROMPT_QUERY).A special type of
FcPromptException that is thrown by the IPromptTypeService when it encounters an
error.A special type of
FcPromptTypeException that is thrown by the IPromptTypeService upon execution of a
prompt query.BPMN modeler for nodes of type provide
resource.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).BPMN modeler for triggers of type
qualified form submit button.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.BPMN modeler for nodes of type queue task.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.BPMN modeler for nodes of type redirect.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).BPMN modeler for nodes of type renew
process id.The
INodeHandler for nodes of type EWorkflowNodeType.FC_RENEW_PROCESS_ID.Model class for the provide resource workflow action (
EWorkflowNodeType.FC_RENEW_PROCESS_ID).BPMN modeler for nodes of type sequence.BPMN modeler for nodes of type return file.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).BPMN modeler for nodes of type save
to file system.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
BPMN modeler for nodes of type save to
web dav.Handler for executing a workflow action of type
EWorkflowNodeType.FC_SAVE_TO_WEB_DAVThe
INodeHandler for nodes of type save to WebDAV.Model class for the save to a WebDav provider workflow action (
EWorkflowNodeType.FC_SAVE_TO_WEB_DAV).BPMN modeler for nodes of type send form record message.Handler for executing a workflow action of type
EWorkflowNodeType.FC_SEND_FORM_RECORD_MESSAGE.Model class for the configuration of plugin message extensions.
The
INodeHandler for nodes of type EWorkflowNodeType.FC_SEND_FORM_RECORD_MESSAGE.Model class for the workflow action (
EWorkflowNodeType.FC_SEND_FORM_RECORD_MESSAGE).Model class for upload requests that may be sent with a message.
BPMN modeler for nodes of type sequence.The
INodeHandler for nodes of type 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_FORM_RECORD_PASSWORD.The
INodeHandler for nodes of type EWorkflowNodeType.FC_SET_FORM_RECORD_PASSWORD.Configuration properties for the set form record password action.
BPMN modeler for nodes of type set saved
flag.Handler for executing a workflow action of type
EWorkflowNodeType.FC_SET_SAVED_FLAG.The
INodeHandler for nodes of type set saved flag.Model class for the workflow node action that marks form records as saved
Use in combination with the
FcTestSystemExtension JUnit test extension ord FcTestSystem annotation.BPMN modeler for nodes of type show
template.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).A JUnit extension for system integration tests.
Bean with additional logic for controlling the
EWorkflowNodeType.FC_SQL_STATEMENT action.BPMN modeler for nodes of type sql
statement.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.BPMN modeler for triggers of type state timer.The
ITriggerHandler for nodes of type EWorkflowTriggerType.FC_STATE_TIMER.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_STATE_TIMER.Servlet that servers the generic static error pages.
BPMN modeler for nodes of type switch.Bean for editing formcycle
EWorkflowNodeType.FC_MULTIPLE_CONDITION nodes.BPMN modeler for nodes of type switch case.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.BPMN modeler for nodes of type switch
default.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.Deprecated.
use
FcTestSystem or FcTestSystemExtension instead.A JUnit extension for system integration tests.
BPMN modeler for nodes of type break.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.BPMN modeler for triggers of type time
point.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.Bean for the user invocation trigger.
BPMN modeler for triggers of type user invocation.The
INodeHandler for triggers of type EWorkflowTriggerType.FC_USER_INVOCATION.A
localization entry for the FcUserInvocationProps model.The properties model for workflow triggers of type
EWorkflowTriggerType.FC_USER_INVOCATION.Deprecated.
Use the default
CommonProfile isntead.Converter for formcycle entities that also implement
IUUIDEntity.MBean implementation of
FCVersionInfoMBean for monitoring the formcycle version.MBean implementation of
FCVersionInfoMBean for monitoring the formcycle version.Monitoring bean interface for obtaining information regarding the current formcycle version.
Monitoring bean interface for obtaining information regarding the current formcycle version.
Default implementation of a
IView.BPMN modeler for nodes of type void.The
INodeHandler for nodes of type VOID.Bean for editing FORMCYCLE
EWorkflowNodeType.FC_WHILE_LOOP nodes.BPMN modeler for nodes of type while loop.Handler for executing a workflow node of type
EWorkflowNodeType.FC_WHILE_LOOP.The
INodeHandler for nodes of type EWorkflowNodeType.FC_WHILE_LOOP.The properties model for workflow nodes of type
EWorkflowNodeType.FC_WHILE_LOOP.BPMN modeler for nodes of type with form element context.Handler for executing a workflow action of type
EWorkflowNodeType.FC_WITH_FORM_ELEMENT_CONTEXT.The
INodeHandler for nodes of type FC_WITH_FORM_ELEMENT_CONTEXT.Model class for the with form element context workflow action
(
EWorkflowNodeType.FC_WITH_FORM_ELEMENT_CONTEXT).BPMN modeler for nodes of type
write form record attr.The
INodeHandler for nodes of type write form record
attributes.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.
This class does not do what the interface promises.
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.
View model for a file control in the prompt query action editor, either a single or multi file control.
Default POJO implementation of
IFileData.General bean for accessing file data of file providing entities.
Deprecated.
View model for the workflow designer, used in the info panel of a node or trigger.
A
file entity adapter for a general file entity.A
file entity adapter for a view of a file entity.A particular
IOException caused by an invalid file formatThe Class FileHandler.
The result of a file import operation, containing details about imported certificates, key pairs, and any errors
encountered.
Model defining how to import a cryptographic file.
A
IValueDescriptor for the metadata of a file, consisting of a file name, base name, extension, and file
size.A part or a form item of a
multipart/form-data POST request that is based upon a
FileItem.Component class for the
<xfc:fileList /> component.Controller (backing bean) for the
FileListComponent component, i.e.Basic POJO implementation of
IFileListDescriptor with a builder.Builder for
FileListDescriptor.Deprecated.
use
XFilenameUtilsClass for storing informations and data for an mail-bodypart based on an file
Metadata for a builtin localizable file property.
A
file entity adapter for a general file providing entity.POJO implementation of
IFileProvidingNodeWithName.POJO implementation of
IFileProvidingTriggerWithName.Common wrapper for file providing entities
POJO for workflow actions that provide a set of files.
The API for making structured REST API calls to the "FilesApi" endpoint.
Default POJO implementation of
IFileSearchOptions.A builder for file search options.
Data class for a file size, which can be given in bytes, kilobytes, megabytes etc.
Converter between a file size in bytes and a human readable representation, such as
5.3 MBAn elFinder connector that serves files from a
ICommonFileSystem instance.Settings for a
FileSystemElFinderConnector.Builder for the settings of a
FileSystemElFinderConnector.Builder for the settings of a
FileSystemElFinderConnector.Builder for the settings of a
FileSystemElFinderConnector.Provides list views of file extensions for
PromptFileSetParameters, backed by their
PromptFileSetParameter.getFileTypes() list.Provides set views of file kinds for
PromptFileSetParameters, backed by their
PromptFileSetParameter.getFileTypes() list.Bean 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.Builder for a file value descriptor.
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.Deprecated.
This is part of the old REST API that will be removed soon.
A
IElFinderFileUrlCreator that creates URLs for the ElFinder connector.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.A
Control for float values that must conform to a IFloatValueDescriptor.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.
Exception thrown when the
FlowchartToBpmnConverter fails.Settings for
FlowchartToBpmnConverter.Input for
FlowchartToBpmnConverter that needs to be passed to the converter.Builder for constructing a
FlowchartToBpmnConverterInput.Default implementation of
IWorkflowBpmnLayoutSettings with a builder.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.
Base class for flow graph end point, used when analyzing the control flow of a workflow processing chain.
A special type of
FlowGraphEndPoint, used when analyzing the control flow of a workflow processing chain.A special type of
FlowGraphEndPoint, used when analyzing the control flow of a workflow processing chain.A special type of
FlowGraphEndPoint, used when analyzing the control flow of a workflow processing chain.A special type of
FlowGraphEndPoint, used when analyzing the control flow of a workflow processing chain.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 or successors 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.Creates graph dot files for a processing chain.
Settings for
FlowGraphToGraphDotConverter.Builder to build
FlowGraphToGraphDotConverterSettings.A font specifier for the text shapers such as
FontTextShaperBuilder.A builder for
FontSpecifier.A builder for a
ITextShaper that uses an Aspose text shaper to measure text.Mode that controls the behavior of the
forbidOptionalProperties
transform step.The
INodeExecutionData published by the FC_FOR_EACH_LOOP.The
INodeExecutionData published by the FC_FOR_EACH_LOOP when
iterating of items provided by a ATTACHMENTS item source.The
INodeExecutionData published by the FC_FOR_EACH_LOOP when
iterating of items provided by a CHARACTER_SEPARATED_VALUES item source.The
INodeExecutionData published by the FC_FOR_EACH_LOOP when
iterating of items provided by a FIELD_VALUES item source.The
INodeExecutionData published by the FC_FOR_EACH_LOOP when
iterating of items provided by a FILES item source.The
INodeExecutionData published by the FC_FOR_EACH_LOOP when
iterating of items provided by a FORM_FIELD_REPETITIONS
item source.The
INodeExecutionData published by the FC_FOR_EACH_LOOP when
iterating of items provided by a JSON_VALUE item source.The
INodeExecutionData published by the FC_FOR_EACH_LOOP when
iterating of items provided by a ROWS_OF_CHARACTER_SEPARATED_VALUES item source.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)
Helper methods for web related tasks such as URL encoding etc.
Helper methods for web related tasks such as URL encoding etc.
Helper methods for web related tasks such as URL encoding etc.
Helper methods for web related tasks such as URL encoding etc.
Helper methods for web related tasks such as URL encoding etc.
Helper methods for web related tasks such as URL encoding etc.
The authentication context for a web 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.
Base clas for
IFormDataAdapter that wraps another adapter and forwards all method calls to that wrapped
adapter.API-Klassse zum Umgang mit
IFormDataAdapter-ElementenDeprecated.
Use
FcEncryptedBinaryType directly with scope parameter "form".Deprecated.
Use
FcEncryptedStringType directly with scope parameter "form".The Class FormDataHandler.
Class for updating the data of a form record, outside a normal form record HTTP submit.
Base class for all exceptions that can be thrown when updating the values of an upload element in a form record.
Exception that is thrown when the content of a new file cannot be read.
Exception that is thrown when upload postprocessing has failed.
Exception that is thrown when the upload element cannot be updated due to some unknown error.
Exception that is thrown when a non-repeated element was requested, but the requested element is inside a
repeated container.
Exception that is thrown when the file extension is not allowed for the element.
Base exception for constraint violation handling.
Exception that is thrown when the number of uploads exceeds the maximum allowed number of uploads for the
element.
Exception indicating that the filename length limit was exceeded for an upload.
Exception that is thrown when the file size exceeds the maximum allowed size for the element.
Exception that is thrown when the number of uploads is below the minimum allowed size for the element.
Exception that is thrown when no files to upload were provided.
Exception that is thrown when the requested element is not an upload element.
Exception that is thrown when a request for specific repetition ID was made, but the requested element is not
repeated.
Exception that is thrown when a specific repetition ID was requested for the element, but no such repetition
exists.
Exception that is thrown when the requested upload element does not exist in the form.
Exception that is thrown when the requested upload element exists in the form, but is not available due to
restrictions such as state or user group dependent availability.
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.
Service providing base functionality of the REST API
FormEingabeDaten +- Vorgang +- Eingangsinformationen (Datum, Nutzer) +- Mapping der Feldnamen-Alias 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.
Test helper methods for form related entities.
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
Model representing a page of
BaseFormFileResources provided by the PUBLIC REST API.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
Web filter that sets the access control headers for the form include resources.
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.A central location for form migration stuff to take place.
POJO model holding data related to the current form edited in the designer.
The model for the form card.
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.
The model for the form page which holds the data from the portal localizations.
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
Provides form placeholders.
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().Entity representing the access to a form record.
API class for reading and writing
FormRecordAccess entities.Implementation of the
IFormRecordAccessDao for reading and writing FormRecordAccess entities.Default implementation of
IFormRecordAppointmentTestConfig.Page model representing a collection of attachments of a form record.
Model representing a page of
BaseFormRecordAttachmentResources provided by the PUBLIC REST API.The API for making structured REST API calls to the "FormRecordAttachmentsApi" endpoint.
Default implementation of
IFormRecordAttachmentTestConfig.Model class for form record base data
Entity representing a form record scoped chat.
API class for reading and writing
FormRecordChat entities.Implementation of the
IFormRecordChatDao for reading and writing FormRecordChat entities.A
IValueDescriptor for the metadata of a form record chat.Builder for a form record chat value that conforms to the
FormRecordChatDescriptor.Handler implementation for reading and writing
FormRecordChat entities.Manager for form record chat and message related operations.
Internal helper class with common helper methods for workflow nodes related to form record chats.
Page model representing a collection of chats of a form record.
Model representing a page of
BaseFormRecordChatResources provided by the PUBLIC REST API.The API for making structured REST API calls to the "FormRecordChatsApi" endpoint.
Service for accessing
form record chat resources via the REST API.DTO for a form record chat filters.
DTO for a form record chats query.
Executes a query for form record chats.
DTO for a form record chats sorting.
Model class for the user of the chat, that is to receive the message.
Factory for creating models for specific form record data
Service providing base functionality of the REST API
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
IFormRecordDoiTestConfig.Default implementation of
IFormRecordFormDatahelper for working with
form record entities.Helper class for working with form records for test purposes.
Request object for retrieving form record history entries.
This class merges the history of a form record from messages and states into one list of history entries.
This class represents one entry in the history of a form record.
View 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).Factory methods for creating a menu model for the view of form records.
API class for reading and writing
FormRecordMessage entities.Service for accessing
FormRecordMessage entities via the REST API.Implementation of the
IFormRecordMessageDao for reading and writing FormRecordMessage entities.A
IValueDescriptor for the metadata of a form record message.A builder for creating a form record message value that conforms to the
FormRecordMessageDescriptor.Helper class for accessing the extension data of
plugin message services.Handler implementation for reading and writing
FormRecordMessage entities.Utility class for creating protocol entries for form record messages.
Model representing a request to create a form record message.
Model representing a request to create a form record message.
Page model representing a collection of messages of a form record.
Model representing a page of
BaseFormRecordMessageResources provided by the PUBLIC REST API.The API for making structured REST API calls to the "FormRecordMessagesApi" endpoint.
Service for accessing
FormRecordMessage entities via the REST API.Model for a form record message service extension.
Bean providing the available form record plugin message service.
DTO for a form record message filters.
DTO for a form record messages query.
Executes a query for form record messages.
DTO for a form record messages sorting.
Entity representing (pending or fulfilled) upload requests for form record messages.
A
IValueDescriptor for the metadata of a form record message upload
request.Builder for a form record message upload request value that conforms to the
FormRecordMessageUploadRequestDescriptor.Page model representing a collection of upload requests of a form record message.
Model representing a page of
BaseFormRecordMessageUploadRequestResources provided by the PUBLIC REST API.Service for accessing
FormRecordMessage entities via the REST API.This class represents the view model for the form record.
The model holding the data for the form record page.
Page model representing a collection of form records.
Model representing a page of
BaseFormRecordResources provided by the PUBLIC REST API.Provides the packages of the generic REST services.
Model class for form record review data
The API for making structured REST API calls to the "FormRecordsApi" endpoint.
Wrapper class for form record selection
REST service providing endpoints for
DetailedFormRecordResources.DTO for a form record filters.
FormRecordsPage
DTO for a form records query.
Query executor for form records.
Query helper for form records.
DTO for a form records sorting.
Page model representing a collection of form records.
Model representing a page of
DetailedFormRecordResource.StateHistoryEntrys provided by the PUBLIC REST API.FormRecordStateResource
Gets or Sets type
Entity representing a form record submission.
API class for reading and writing
FormRecordSubmission entities.Implementation of the
IFormRecordSubmissionDao for reading and writing FormRecordSubmission entities.Handler implementation for reading and writing
FormRecordSubmission entities.Default implementation of
IFormRecordSubmissionTestConfig.Default implementation of
IFormRecordTestConfig.Utility class for form records.
Default implementation of
IFormRecordWorkflowDataContext of an form-render-request with data for an renderer-call
Builder for creating an form-render-context.
Wrapper for an
IFormRenderContext that delegates all calls to the wrapped instance.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
Helper for repeated form fields.
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.
Page model representing a collection of forms.
Model representing a page of
BaseFormResources provided by the PUBLIC REST API.Model representing a page of
BaseFormResources provided by the PUBLIC REST API.Provides the packages of the generic REST services.
Liefert eine (Nur-Lese-)Sicht für Postfachbearbeiter, die eingegebene Formulardaten zu einem bestimmten Vorgang
anzeigt.
The API for making structured REST API calls to the "FormsApi" endpoint.
The API for making structured REST API calls to the "FormsApi" endpoint.
Bean for exporting a copy of the form.
FormsPage
Builder for the event data for a form submission event, i.e. when the user clicked on a submit button.
The model for the form tag.
List of requested resources.
Model representing a end user tag.
FormTagResourcePage
Model representing a page of
FormTagResources provided by the PUBLIC REST API.Utilities for finding, adding and deleting form templates in the form designer, see
FormDesignerTemplateBean.API class for common operations on
form themes.Bean for the backend, when editing
client form theme entities.POJO for the data of a form theme, used e.g. when exchanging data between a master and frontend server.
A builder for form theme data instances.
Bean for deleting client form themes.
Model with a factory method for deleting
client form themes.A single item from a
FormThemeDeletionModel.ThemeGroup that represents a client form theme to be deleted.A group of themes that were requested to be deleted.
Model with additional data for the selected client form theme, such as a list of files that can be edited.
Implementation of the list model for the client form themes, when the edit mode is set to
SIMPLE.Model with additional data for the selected client form theme, such as the content of the CSS files.
Helper for editing the data of a
ClientFormTheme in the elFinder file explorer.Represents a session for the elfinder explorer, used by the UI for editing the files of a
file system.Controller bean for the file manager tab of the client form theme backend UI.
An
IFileSystemEntry implementation for client form theme files.A reference to particular file from a
IFormTheme.Parameters for resolving a file from a form theme, see
FormThemeManager.A builder for creating
file resolution params.Manager for the client form themes of a client.
POJO view of a
ClientFormThemeFile, without relations to other entities.Handler implementation for the
IFormHandler that allows common operations on form themes.A
FormThemeReference with a display name.Details regarding a CSS URL, used by
FormThemeItem.Manager for
IFormTheme.A reference to a form theme that is used to style a form.
A form theme reference to a client form theme.
A special type of
FormThemeReference.Matcher for a form theme that returns a given default value for each type of theme.A form theme reference to a form theme provided by a plugin, i.e.
FastJson deserializer for
FormThemeReference.A matcher on a
FormThemeReference.A form theme reference to a system form theme, i.e. a form theme that is provided by the formcycle application.
Faces converter for
FormThemeReference.Deprecated.
In the future each domain should provide its own import/export mechanism.
POJO implementation of
IFormThemeResource.Base class for all runtime exceptions thrown related to form themes.
UI helper methods for form themes (
IFormTheme, FormThemeReference).This update creates a new
client form theme for each CSS text template.This update updates all new
form versions and sets the form theme to the newly created
client form themes.This update updates all new
text templates of type
HTML, and sets the allow custom form
theme flag to true when the HTML text template contains only default styles and no custom styles.POJO model representing all usages of a form theme within the system and within each client.
POJO view of a
ClientFormTheme, without relations to other entities.Keeps track of all existing
client form themes for a specific client.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.
Writes the form version properties from the persist JSON to the database table.
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.
Entity for properties of a frontend server.
API class for
FrontendServerProperty.Handler class for
FrontendServerProperty.Bean for providing frontend servers of clients.
Listener for FrontendServer updates.
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.Cache storing user login attempts.
Authentication provider for the FS communication.
Implementation of the client-side of the FS communication.
Contains the configuration of the frontend server that can be edited via the backend UI.
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.
Bean to provide information about the connection to a
FrontendServer.Model class for displaying information about the connection to a
FrontendServer.Deprecated, for removal: This API element is subject to removal in a future version.
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.Implementation of the
RpcHandlerProducer on the frontend server.Diese Klasse implementiert einen Frontendserver gegen den sich verbunden werden kann.
Implementation of the server-side of the FS communication.
Data transfer object for information about the frontend server.
Class for accessing the frontend server properties.
Deprecated.
View model for a fulfilled upload request to display in the chat.
Base exception for exceptions that can occur when fulfilling an upload request.
Exception indicating that the chat of the upload request does not match the expected chat.
Exception indicating that the file is empty and cannot be used to fulfill for the upload request.
Exception indicating that the file extension is not allowed for the upload request.
Exception indicating that the limit on the maximum number of files was exceeded for the upload request.
Exception indicating that the file size limit was exceeded for the upload request.
Exception indicating that the limit on the minimum number of files was not met for the upload request.
Exception indicating that the chat of the upload request does not match the expected chat.
Exception indicating that the message of the upload request does not match the expected message.
Exception indicating that a file without an explicit content was provided to fulfill the upload request.
Exception indicating that a file without a file name was provided to fulfill the upload request.
Exception indicating that no user was provided to fulfill the upload request (and that a user is required to
fulfill the request).
Exception indicating that no files were provided that could be used to fulfill the upload request.
Exception indicating that the form record does not contain form data for the upload request.
Generic exception indicating that the upload request could not be fulfilled due to an unknown or unhandled error.
Exception indicating that the upload element constraints were violated for the upload request.
Exception indicating that the upload request was already fulfilled (and cannot be fulfilled again).
Exception indicating that the upload request with the given UUID was not found.
Exception indicating that the user is not a member of the chat containing the message with the upload request.
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.Deprecated.
Use
Gagawa instead.Workaround to access protected objects from Gagawa, to work around bugs or missing features.
A
ITreeAccessor for Gagawa DOM Nodes.Deprecated.
View model for layout settings related to various
gateways in BPMN diagrams.Bean for displaying general error pages.
GeneralLocalizations
General resource bundle for the user portal.
Bean for accessing the
GeneralResourceBundle.Deprecated.
This is part of the old rest API.
Logout logic that removes refresh tokens from user profiles upon logout.
View model for general layout settings related to BPMN diagrams.
View model for custom authenticator config of type
EAuthClientType.PASSWORD_GENERATOR_ACTIONWrapper for authenticator configs of type
EAuthClientType.PASSWORD_GENERATOR_ACTIONGeneric 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.
Provides the packages of the generic REST services.
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.PlaceHolder implementation for plain or HTML text fragments (e.g. to make them manageable by the placeholder
dialog).Utility class for geometrical operations in a 2D space.
POJO with parameters for
IWorkflowProvider.getAvailableAttachments(NodeKey, GetAvailableAttachmentsParams).A simple builder for configuring a
GetAvailableAttachmentsParams POJO.POJO with parameters for
IWorkflowProvider.getAvailableResources(NodeKey, GetAvailableResourcesParams).A simple builder for configuring a
GetAvailableResourcesParams POJO.Default POJO implementation of
IGetDisplayLabelParams.POJO implementation of
IGetElementPrototypesParams.Default POJO implementation of
IGetElementSummaryParams.Deprecated.
Default POJO implementation of
IGetFilterCriteriaForObjectsParams.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.Producer for the global cache manager.
Model class for the properties of an authenticator of type
EAuthClientType.GOOGLE.Deprecated.
Use
GoogleAuthenticatorProperties instead.Deprecated.
Use
XGraphUtilsAn attribute list for graphs.
Static methods for creating
graph dot elements.Writer for creating content conforming to the graphviz dot language syntax specification, see DOT Language.
Writer for creating content conforming to the graphviz dot language syntax specification, see DOT Language.
Writer for creating content conforming to the graphviz dot language syntax specification, see DOT Language.
A
Control that marks the end of a group of controls, a visual box around a set of controls.A
Control that marks the beginning of a group of controls, a visual box around a set of controls.GrowlMessages
The model for the growl messages.
Adapter 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
Helper for custom UIs with beans that come from either a plugin class or from a built-in class.
A builder for creating instances of
GuiBeanCache.Default implementation of
IGuiIcon for common icon libraries.Model for a GUI image with a source and an alternative description.
Helper for accessing localized strings.
Class to determine and check the hardware-id
A
IFallbackFontFinder that inspects which font supports which codepoints.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.
Registry for health checks.
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.Exception thrown when an HTML string could not be parsed.
Represents an HTML string that can be used for graph dot attributes to output HTML, e.g. for label.
A converter that trims empty HTML strings to the empty string.
Provider for the HTML templates available during workflow editing and validation.
Applies HTTP basic authentication with a username and password to a request.
Applies HTTP basic authentication with a username and password to a request.
Applies HTTP basic authentication with a username and password to a request.
Applies HTTP basic authentication with a username and password to a request.
Applies HTTP basic authentication with a username and password to a request.
Applies HTTP basic authentication with a username and password to a request.
An authentication that uses a given bearer token for authentication.
An authentication that uses a given bearer token for authentication.
An authentication that uses a given bearer token for authentication.
An authentication that uses a given bearer token for authentication.
An authentication that uses a given bearer token for authentication.
An authentication that uses a given bearer token for authentication.
Qualifier for the HTTP client type, can be when injecting client or API providers via CDI.
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.
Sub builder for configuring the property added via
ValueDescriptorFormModelBuilder.addDescriptor(IValueAccessor, IValueDescriptor) .Sub builder for configuring the property added via
ValueDescriptorFormModelBuilder.addDescriptorAtKey(IValueAccessor, String, IValueDescriptor)Sub builder for configuring the property added via
addDescriptorListAtKeyDeprecated.
This is part of the old workflow, use the new workflow engine.
Deprecated.
Represents a laid out BPMN element that has a single
text annotation./** Represents a laid out BPMN element that has a visible
TextAnnotationA
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.
Options for
IWorkflowFileHandler#attachFilesToFormRecordCommon 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.
Deprecated.
Add a field your POJO that is of type
FileProvision.An interface for objects that can have custom attributes associated with them.
Common interface providing information about a users authentication.
Base interface representing a response to an authentication token request.
Common interface describing the target of an authentication request e.g.
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
Common interfaces for models representing the properties of an
IAuthenticator.Deprecated.
Use
de.xima.fc.security.interfaces.authentication.IAuthenticatorProperties instead.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.Base builder for configuring a
BaseActionProps event listener.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.
Mixin for nodes that wish to register the default client-side do-until loop handlers.
Basic environment data for message service extensions.
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.Base builder for configuring a
BaseTriggerProps event listener.Mixin for nodes that wish to register the default client-side while loop handlers.
Environment data required when performing workflow related operations.
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.
Used by
GuiBeanCache.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 constructor that can create a new instance of a type, requiring two parameters.
A builder for an HTTP request body that can have binary data items, such as a multipart body.
Model for rest service method parameters.
IBinaryFileInput
A flow label helper for binary selection
gateways, i.e. gateways with two branches, usually an if and
an else branch.A builder for a flow label helper for binary selection
gateways, i.e. gateways with two branches,
usually an if and an else branch.Model for rest service method parameters.
A
IValueBuilder for creating a boolean value.A
IValueDescriptor for a boolean value.A
IValueDescriptorBuilder for creating a boolean value descriptor.A laid out BPMN element with an explicit start and end event.
Interface for objects that can localize message keys in a contextually bound locale, optional with parameters.
Interface for compatibility-related settings with various BPMN tools, used when creating a BPMN diagram.
Generic interface for a container that holds a single BPMN element or provides access to it.
Represents the layout of a BPMN element, including the final
IWorkflowBpmnAlignmentItem and possibly some it
its parts, such as the name or text annotation.Provides access to all BPMN elements when creating a BPMN diagram.
Mixin for all built-in workflow node handlers.
Adds default implementations for
IElementHandler.getJavaScript(Locale, boolean) and
IElementHandler.getCascadingStyleSheet(Locale, 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
A read-only map that associates values with the four
cardinal directions in 2D space
(north, east, south, west).A map that associates double values with the four cardinal directions (north, east, south, west) in a 2D space.
A map that associates int values with the four cardinal directions (north, east, south, west) in a 2D space.
A map that associates long values with the four cardinal directions (north, east, south, west) in a 2D space.
Interface for a model representing a certificate that can be imported into a formcycle keystore.
Common interface for the localizer of the certificate module.
Builder for configuring a change form record chat activeness node.
A builder for workflow node for a
EWorkflowNodeType.FC_CHANGE_FORM_VALUE that modifies the value of one or
more form elements.Interface for quartz job details for state change jobs of the old workflow.
Common interface for all chat entries as seen in the backoffice inbox.
High-level methods for interacting with portal chats and messages.
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.
Data access object for creating, updating, and deleting
ClientFormTheme entities.Handler for
ClientFormTheme entities.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.Use by
GuiBeanCache.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.
Deprecated, for removal: This API element is subject to removal in a future version.
listen to
ClusterNodeJoinedEvent or
ClusterNodeLeftEvent insteadAn 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.High-level interface for abstracting common file system operations.
Manager for multiple
file systems.Represents a volume of a file system, such as a Windows drive or FTP mount.
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.
Replacer for context placeholders.
Replacer for the placeholder of a specific context, used by
IContextReplacerParams.getReplacerMap().Represents the result of
INodeHandler#execute when the node was
completed abruptly by issuing a local control transfer statement (e.g. a break or continue statement).Map like interface for the
IComponentValueConverter.Common interface for counter entities
Accessor (getter+setter) for the time when an object was created.
Getter for the time when an object was created.
Setter for the time when an object was created.
Accessor (getter+setter) for the name of the user who created an object.
Getter for the name of the user who created an object.
Setter for the name of the user who created an object.
Context provided to the node handlers during a call to
createFlowGraph.Interface for the parameters that are passed to
createFlowGraph of
IWorkflowNodeFlowAnalyzer.Data for creating a new form record chat.
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.
A persistence adapter for entities that allows CRUD operations, e.g. create, read, update, delete.
Interface representing a cryptographic file type, providing methods to retrieve the file extension and MIME type.
Common interface for cryptographic elements, that can be imported into a keystore, such as certificates or keystore
entries.
Builder for the value provided by a node while it is being executed.
Interface for object that provide custom attributes, i.e. key-value pairs that can be used to store additional
information.
Interface for entities that store custom attributes, i.e. key-value pairs that can be used to store additional
information.
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
Information about a
DataSource's runtime state, such as the number of active and idle connections.Similar to
Map, but with a more limited set of operations.Like a
Supplier for a IDataStore, but with the correct type parameters.Deprecated.
This is part of the old rest API.
API handler for
data source entities.Interface für Datenquellen-Parameter
Deprecated.
Deprecated.
Deprecated.
Deprecated.
This was renamed.
Trigger handler for triggers that wish to register the default client-side handlers.
A constructor that can create a new instance of a type, without requiring any parameters.
Deprecated.
Deprecated.
A builder for
message localizers with common options.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 entitiesBase type for all graph dot statements that can be used in directed graphs.
Represents 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.Information about a JDBC driver.
Service for managing JDBC drivers, including registering, unregistering, and retrieving driver information.
Interface for DSA key pair generation specifications.
Handles requests to the dynamic resource servlet for a thumbnail of a file entity or file system entry from a
ICommonFileSystem.Interface for EC key pair generation specifications.
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).Deprecated.
Used by
IElementPropertiesBean.updateCurrentTask(IElementUpdateCurrentTaskParams), which is
deprecated.Represents a workflow element together with the
WorkflowTask to which it belongs.Evaluator for EL expression.
Creates a file name for a duplicated (copied) file or folder.
Provider for the settings of file system entries, e.g. whether the directory of file is read-only, or how many files
can be uploaded.
Creates URLs for files on the file system, used by the elFinder feature.
Encoder and decoder for file and directory file paths.
Decoder for ElFinder file hashes.
Encoder for file and directory file paths.
Handler handles image processing operations for the elFinder connector, when the resize command is used to modify
images, such as by scaling or rotating them.
Base parameters for the image processing operations, see
IElFinderImageProcessor.Parameters for the crop operation, see
IElFinderImageProcessor.cropImage(Path, Path, IElFinderImageProcessorCropParams)Parameters for the rotate operation, see
IElFinderImageProcessor.rotateImage(Path, Path, IElFinderImageProcessorRotateParams)Parameters for the scale operation, see
IElFinderImageProcessor.scaleImage(Path, Path, IElFinderImageProcessorScaleParams)Extracts the size of an image, used by
FileSystemElFinderConnectorConfig.Detector for the mimetype of a file.
Finds the file entity ID corresponding to a file system entry, used by the thumbnail generator.
Creates URLs for thumbnails of image files on the file system, used by the elFinder feature.
Builder for configuring a
EWorkflowNodeType.FC_EMAIL action.Deprecated, for removal: This API element is subject to removal in a future version.
The system EntityManagerFactory is now managed in the fc-persistence module.
DAO for reading and writing
EndUserState entities.Interface for server models that are backed by an entity.
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.A factory interface for creating new instances of
IEntityContext.CDI qualifier for
IEntityContextFactory that indicates a contextual entity context factory is desired.CDI qualifier for
IEntityContextFactory that indicates an isolated entity context factory is desired.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
Deprecated.
Common interface for parameters needed for entity deserialization
Common interface representing the result of an entity deserialization
Deprecated.
Common interface for entity exporters
Deprecated.
Bean adapter the entities of a
EntityFileSystem.Persistence adapter for an
EntityFileSystem.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.Deprecated.
Prefer the more generic
IObjectReference interface instead.Deprecated.
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.
Interface for errors that can be returned to the client.
Declares functionality for error details retrieval, usually implemented by exceptions.
Interface for error providers for initializing available errors.
Error data provided by a workflow node either when
INodeHandler#execute throws an exception or completes normally with soft
errors.Common interface for events.
A
IStructuredBpmnModelPartBuilder for parts that can contain 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
Describes the parameters needed to execute a prompt query, see
IPromptTypeService.executeQuery(IPromptServiceType, IExecutePromptQueryParams, Object, Object). .Describes the return value of a prompt query execution, see
executeQueryMixin with the implementation of
createFlowGraph for
node handlers that have no children and simply execute some business logic.Mixin with the implementation of
createFlowGraph for
node handlers that execute one of its two children based on a test, such as an if-else node.Mixin with the implementation of
createFlowGraph for
node handlers that have no children and simply always transfer control to another node, such as
a break or continue statement.Mixin with the implementation of
createFlowGraph for
node handlers that attempt to execute its body child node, and run another child if the child
completed abruptly by throwing an exception, optionally always running a finalizer block at the end, such as a
try-catch(-finally) block.Mixin with the implementation of
createFlowGraph for
node handlers that execute their children like a switch statement.Mixin with the implementation of
createFlowGraph for
node handlers that execute their child in a post-test loop, such as a do-until loop.Mixin with the implementation of
createFlowGraph for
logic handlers that execute their child in a pre-test loop, such as a while loop or a for-each loop.Mixin with the implementation of
createFlowGraph for
node handlers that have no children and always complete abruptly by either throwing an exception
or issuing a return statement.Mixin with the implementation of
createFlowGraph for
node handlers that have no children and always complete abruptly by issuing a return statement.Mixin with the implementation of
createFlowGraph for
node handlers that have no children and always complete abruptly by issuing a return statement.Mixin with the implementation of
createFlowGraph for
node handlers that have no children and always complete abruptly by throwing an exception.Each action may create data when it is executed.
Common interface for results of unzipping formcycle export files
Interface for extending form-contexts with
HttpServletResponse and HttpServletRequestExtended data for fulfilling a
form record message upload request that
provides more settings, but requires access to deeper system functionality.Extended response for fulfilling a
form record message upload request that
provides more data, but requires access to deeper system functionality.A parameter model with additional settings such as group items.
Extended data for posting a
form record message that provides more settings, but requires
access to deeper system functionality.Extended response for posting a
form record message that provides more data, but requires
access to deeper system functionality.Extended data for a
ITriggeredWorkflowExecutionResult that provides more data, but requires access to deeper
system functionality.Interface for external user references.
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).Performs an upgrade of a
JSONObject from a previous version to a newer version or downgrade of a
JSONObject from a newer version to a previous version.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 data returned by
EWorkflowNodeType.FC_CHANGE_FORM_RECORD_CHAT_ACTIVENESS actions.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_DO_UNTIL_LOOP 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.Deprecated.
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
EWorkflowNodeType.FC_FOR_EACH_LOOP action.A builder for a workflow node of type
EWorkflowNodeType.FC_FOR_EACH_LOOP that loops over a fixed collection
of elements.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_POSTED event.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_POSTED event.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.The result descriptors for the data returned by the
EWorkflowNodeType.FC_WHILE_LOOP 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_PROMPT_QUERY 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 data returned by
EWorkflowNodeType.FC_LOG_ENTRY actions.The result descriptors for the data returned by the
EWorkflowNodeType.FC_SET_FORM_RECORD_PASSWORD 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.The result descriptors for the data returned by the
EWorkflowTriggerType.FC_USER_INVOCATION event.Interface for
events that trigger a FC_USER_INVOCATION trigger.Deprecated.
Use
IUser or default UserProfiles instead.The result descriptors for the data returned by the
EWorkflowNodeType.FC_WHILE_LOOP action.The result descriptors for the data returned by the
EWorkflowNodeType.FC_WITH_FORM_ELEMENT_CONTEXT action.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
A
IStructuredBpmnModelPartBuilder that allows for child parts to be added.Common interface for accessing files.
Body builder for writing the content of an file to an HTTP request
Common interface for the data of a file.
Common interface for the data of a file entity
A persistence adapter for entities that allows access to a binary file.
A view of a
file entity, used by FileEntityViewPersistenceAdapter.A builder for a list of workflow files.
A configurator for a list of workflow files.
A descriptor for a list of files provided by a workflow trigger or node when the trigger fires or the node gets
executed.
Interface for handling files within the
<xi:fileList handler=#{...}/> component.Common interface for entities that provide a list of files.
Represents an uploaded file in the
<xi:fileList /> component.Common interface for classes providing a file map
Common interface for the metadata of a file entity
Deprecated.
This should be implemented together with
getSuccessValueDescriptor etc., e.g. in a separate specific mixin interface for the node handler.A reference to a workflow node that provides files, such as those returned by
IWorkflowProvider.getNormalCompletionProvidingPredecessors().A reference to a workflow trigger that provides files.
Reference to a workflow node or trigger that provides files.
Model for workflow actions that provide a set of files.
Handler for errors that may occur when a
IFileProvision is handled, see
IWorkflowFileHandler#handleFileProvision.Options for
IWorkflowFileHandler#handleFileProvisionHigh-level methods for downloading and upload files and attachment.
Options that influence how files are retrieved by
resolveReferencedFiles.Accessor (getter+setter) for the file size of an object representing a file.
Getter for the file size of an object representing a file.
Interface for providing the file size in bytes.
Setter for the file size of an object representing a file.
Represents an entry in a file system, i.e. a file or a directory.
An accessor for file system entries of a given type of object.
Factory for creating file system entries.
Common interface for upload constraints.
A builder for a file value.
A configurator for a file value.
Descriptor for the files provided by a workflow element, such as the files made available when a trigger fires or
when a workflow node gets executed.
Builder for configuring a
EWorkflowNodeType.FC_FILL_PDF action.Common interface for logging filters
Common interface for entity filters for use in
DaoLazyDataModel.The result of
flattening an
IWorkflowBpmnAlignmentItem, with the positions of all child items resolved.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.A
IStructuredBpmnModelPartBuilder that allows for interconnections to be drawn between the part's
constituents via sequence flow.Interface for an object that is able to locate dead workflow nodes.
Data associated with an edge of a flow graph, see
ITaskFlowAnalysis#getValueFlowGraph 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 nodes in the subtree of a node where execution
of that node can end when it is executed.Filter for the nodes and edges of a workflow node flow graph,to exclude some existing nodes or edges.
The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP.The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP when iterating over
items provided by an attachments item source.The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP when iterating over
items provided by a character separated values item source.The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP when iterating over
items provided by a field values item source.The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP when iterating over
items provided by a files item source.The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP when iterating over
items provided by a form element repetitions value item source.The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP when iterating over
items provided by a JSON value item source.The
INodeExecutionData published by the EWorkflowNodeType.FC_FOR_EACH_LOOP when iterating over
items provided by a rows of character separated values item source.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).Represents a request to update the value of an upload element in a form record with new files.
Represents the response when the value of an upload element in a form record was updated with new files.
Environment data required within the form designer.
INodeExecutionData for nodes that wish to enter a form element field value index context during their
execution.INodeExecutionData for nodes that wish to enter a form element repetition context during their execution.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
DAO for reading and writing
FormRecordAccess entities.Handler for
FormRecordSubmission entitiesCommon interface for form record appointment test configurations.
High-level methods for interacting with form record attachments.
Common interface for form record attachment test configurations.
Common interface for base data of a form record.
DAO for reading and writing
FormRecordChat entities.Handler for
FormRecordChat entitiesA reference to an existing form record chat.
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 form record Double-Opt-In test configurations.
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.Data for adding an attachment to a form record message.
DAO for reading and writing
FormRecordMessage entities.Handler for
FormRecordMessage entitiesBuilder for configuring a
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_POSTED event listener.Interface for the event when a
message was posted to a form record
chat.Builder for configuring a
EWorkflowTriggerType.FC_FORM_RECORD_MESSAGE_UPLOAD_REQUEST_FULFILLED event
listener.Interface for the event when an
upload request was fulfilled by uploading an
attachment.Resolver for meta information of a
FormRecordMessageUploadRequest.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.
High-level methods for interacting with form records.
Common interface representing context data needed for form record scoped
IUriResolvers.DAO for reading and writing
FormRecordSubmission entities.Handler for
FormRecordSubmission entitiesCommon interface for form record submission test configurations.
Common interface for form record test configurations.
Common interface for the data of an upload element of a form record.
Common interface for the data of a default (non-dynamic) upload element.
Common interface for the data of a dynamic upload element.
Common interface for the descriptor of an uploaded file.
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.
High-level methods for interacting with portal forms.
Interface for the event when a form was submitted via an HTTP request.
Interface for a form theme.
Represents a chain of form themes.
Handler for common operations on
form themes.Resolves a
form theme reference to a form theme.A single resource from a
IFormTheme.A post processor for form values that is executed after the value was resolved, see
IFormReplacerParams.getFormValuePostProcessors().Parameters provided to a
form value post processor when processing form field values.Return value of a
IFormValuePostProcessor.postProcess(IFormValuePostProcessorParams).Common interface representing context data needed for form version scoped
IUriResolvers.Common interface for frontend server configurations allowing access to frontend server settings and features.
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
Basic data for fulfilling a pending
upload request.Arguments of a function to evaluate.
Data access object working for different kinds of entities that provide binary file content.
A statement that can be used both in directed and undirected graphs.
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).Deprecated.
Parameters that are passed to
IElementHandler.getFilterCriteriaForObjects(IGetFilterCriteriaForObjectsParams).Parameters that are passed to
INodeHandler.getNodePrototypes(IGetNodePrototypesParams).Parameters that are passed to
ITriggerHandler.getTriggerPrototypes(IGetTriggerPrototypesParams).Parameters passed to
IXItemWidget.getJavaScriptData(IGetWidgetResourceParams) andBase type for attribute lists.
Interface for elements that may appear as the source or target node in an edge statement.
Base type for directed and undirected edge statements.
Base type for all graph dot elements.
Base type for directed and undirected graphs.
Base type for all graph dot elements that can be used as statements.
Base type for directed and undirected graph dot sub graphs.
Base type for directed and undirected graph dot sub graph statements.
Common interface for group menu entries.
Common 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.
Represents the result of
IWorkflowFileHandler#handleFileProvisionThe 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).
Represents a table with rows and a header.
Represents a row in a table.
Interface for a health check.
Interface for a health check result.
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 for objects that can generate thumbnails for images.
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
Common interface for requests to read the upload element data of a form record from inside the inbox.
A
IStructuredBpmnModelPartBuilder that allows for incoming connections.Allgemeine Schnittstelle für indexbasierte Entitäten.
DAO for reading and writing
IndirectClientAuthorization entities.Handler for
IndirectClientAuthorization entities.The individual conditions to combine.
Interface for the node prototypes that should be set when a new task is created.
A supplier for an
InputStream that can throw.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).Describes a list of entities of which one can be selected.
Specialized entity sorting criterion for sorting via in Java.
Interface for data of an scheduling-task
Common interface representing a JPA transaction context, which encapsulates a single JPA entity transaction.
Builder for creating JSON data.
Matches the contents of a JSON value, depending on whether it is a JSON primitive value, an array, or an object.
Interface for iterating over JSON-like data.
Interface for a class that behaves like a JSON object in that it has key value pair.
Converter for converting between JSON primitives and strings.
A transformer that applies a series of transformation steps to a JSON schema.
A builder that lets you configure a set of transformation steps to be applied to a JSON schema.
A single JSON validation error, containing a location and a message.
Result of validating a JSON.
Common interface for
IFileEntitys that depend on a file keyInterface for resources that are dependent on a key.
Base interface for key pair generation specifications.
Common interface for a keystore entry.
Common interface for view models of key store entries.
Mixin 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.Accessor (getter+setter) for the time when the last modification to an object was made.
Getter for the time when the last modification to an object was made.
Setter for the time when the last modification to an object was made.
Accessor (getter+setter) for the name of the user who made the last modification to an object.
Getter for the name of the user who made the last modification to an object.
Setter for the name of the user who made the last modification to an object.
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.Factory interface for creating LDAP connections.
Interface for license access.
Interface for checking if a property is authorized for a given license.
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 deprecated registrator that does nothing.
Matcher on the subtype of
AListItemSourceProps.A
IValueBuilder for creating a list value.A
IValueDescriptor for a list value.A
IValueDescriptorBuilder for creating a list value descriptor.Deprecated.
Use
ILocalizedMessageProvider instead.Common interface for entity localizations.
Common interface for all objects (mainly entities) that have got localization entities for the purpose of
internationalization.
UI view model that lets the user edit localizable messages for potentially arbitrary languages and message keys.
An entry with a map of messages for a given locale, used as part of
ILocalizationViewModel.Common interface for localized database objects.
Common interface for localized file entities.
Common interface for entities providing
localized files.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.
Common interface for logout logic.
Base interface for data provided by workflow nodes that represent a loop.
Mixin with an implementation of
validateGlobal
for node handlers that implement some kind of loop and wish to enforce that a loop is actually
possible.Apache PDF Box based
IPdfConverter implementation for common raster image formats.Represents the parsed parameters for the
FormPreviewImageServlet.Represents the width and height of an image file, i.e. a width and height in pixels.
Constraints for generating image thumbnails, see
IImageThumbnailGenerator.A builder for
ImageThumbnailGeneratorConstraints.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).The result of an email encryption operation, including the
encrypted message and the results for
each recipient.Interface for mail-encryptors
Interface for certificate-providers for the mail-encryption
Configuration for mail security (encryption and signing) when sending an email.
A report detailing the security features applied to an email, including encryption and signing results.
Mail server settings for sending mails.
The result of an email signing operation, including the sender address used for signing, whether the signing was
successful, and any exception that occurred if it was not.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.
Common interface for menu entries.
Interface for objects that can localize message keys in a given locale, optional with parameters.
High-level methods for interacting with portal messages.
Common interface for form record message services, providing methods to interact with form record messages.
Interface for accessing the Multi-Factor Authentication (MFA) settings of the system.
Immutable implementation of
IHeaderTable.Parameters that are passed when modelling a workflow element, see
IWorkflowTriggerBpmnModeler and
IWorkflowNodeBpmnModelerParameters that are passed when modelling a workflow item, see e.g.
Parameters that are passed when modelling a
workflow node, see IWorkflowNodeBpmnModelerParameters that are passed when modelling a
workflow process.Parameters that are passed when modelling a
workflow task.Parameters that are passed when modelling a
workflow trigger, see
IWorkflowTriggerBpmnModelerDeprecated.
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.
Service interface for handling authentication-related operations on the master server.
Interface for a POJO view model class that describes a list of attachments that can be selected by the user.
Contract for builders that allow configuring multiple conditions.
Represents a nested list where items can be associated with multi indices, similar to a multidimensional array.
Interface for a POJO view model class that describes a list of files that can be selected by the user.
Represents a multipart body with its content type, content length and body data.
A builder for an HTTP request multipart body (
multipart/form-data).Mixin for workflow nodes with props of type
BaseMultipleConditionProps.Common interface for node property models that let the user configure multiple checks, such as conditions or while
loops.
Builder for configuring a multiple condition node.
Interface for a
shaping text wrapper whose options can
be changed after it has been created.Represents a laid out BPMN element that has a visible
name.Interface for a wrapper that provides a name for the named element.
Interface for elements that have a display name in a specific locale, often used for UI elements.
Deprecated.
use
INamedUiElementCommon interface for all objects (mainly entities) that have got a name.
Common interface for all objects (mainly entities) that have got a name.
Provider for the inboxes available during workflow editing and validation.
Builder for
IInboxFormRecordRequestsFactory for creating default
IInboxFormRecordRequestsFactory for
IInboxFormRecordUploadElementDataRequestsDeprecated.
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.
Wraps user-specific settings related to the sort field and order of inbox tables.
Class for setting up the inbox security.
Servlet for saving the submitted form data and triggering the workflow from the inbox.
Deprecated.
Belongs to the old workflow engine.
View model for layout settings related to
inclusive gateways in BPMN diagrams.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.Deprecated.
Handler 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.Base interface for data provided by a
node while it is being executed, set via
provideExecutionData() and
accessible via getExecutionDataForNode().Interface for the parameters that are passed to
INodeHandler.execute(INodeExecutionParams).All node handlers must be thread-safe.
Interface for workflow node like objects that have got a
NodeKey identifying them.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.
Builder for the exception thrown by a node when it wishes to peform an abrupt local control transfer, e.g. by issuing
a break or continue statement.
A reference to a workflow node, such as those returned by
IWorkflowProvider.getNormalCompletionProvidingPredecessors().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.
InputPart
InputPartMediaType
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.
A
Control for integer values that must conform to a IIntegerValueDescriptor.GSON type adapter for (de-)serializing interfaces marked with
ISerializableInterface.GSON type adapter factory for creating type adapters for interfaces.
View model for layout settings related to
intermediate catch events in BPMN diagrams.View model for layout settings related to
intermediate throw events in BPMN diagrams.Deprecated, for removal: This API element is subject to removal in a future version.
The system EntityManagerFactory is now managed in the fc-persistence module.
Authenticator that validates the token and checks if the token is cached.
Generates internal tokens for the user profile.
Cache for storing internal tokens
Helper class for internal tokens.
Authenticator for retrieving
UserProfiles by validating formcycle user credentials.View model for interoperability settings related to BPMN diagrams.
A
IValueBuilder for creating a null value.A
IValueDescriptor for a null value.A
IValueDescriptorBuilder for creating a null value descriptor.Exception thrown when executing a prompt query whose configuration is invalid.
Builder for a
InvalidConfigurationException.Handlers for invalid credentials on AJAX authentication requests that return JSON content.
Thrown by
FcForEachLoopItemListCsv.evaluate() when the value is not a valid character separated values string as defined by
the ListItemSourcePropsCharacterSeparatedValues.Exception thrown when executing a prompt query with input parameters that are invalid and do not match the input
expected by the prompt query, e.g. because a required parameter is missing or an image file was provided when image
files are not allowed.
Builder for a
InvalidInputParamsException.Thrown by
FcForEachLoopItemListJson.evaluate() when the value is not a valid string representation of a JSON value as defined
by the ListItemSourcePropsCharacterSeparatedValues.Exception thrown when executing a prompt query and the query produces unexpected output that does not match the
expected output format, e.g. because the response from the AI service was malformed or incomplete.
Builder for a
InvalidOutputParamsException.Exception that is thrown when a token is invalid.
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.
A reference to an object (a concrete instance of a certain type of objects), consisting of the type of the objects
and the unique identifier of the object within that type.
Interface describing an entity reference and its location
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 for instances that can provide an opaque color as a hex RGB value, e.g. 0x#FF0000 for red.
Interface that allows the ordering of classes using the
SequenceOrder annotaionA
IStructuredBpmnModelPartBuilder that allows for outgoing connections.Common 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.
Defines functionality to convert data into the PDF format.
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.Common interface for placeholders.
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.
Context for providing various information needed for providing placeholders.
Markup interface for placeholder provider.
Common interface for asynchronous placeholder provider.
Common interface for synchronous placeholder providers.
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.
Used by
GuiBeanCache.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 consequent ("if") or alternate ("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
An extractor for the beans and XHTML view of a plugin that provides a custom GUI.
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.
Mixin meant for
IPluginWorkflowNode plugins that only wish to provide a workflow do until loop that runs a
test and executes the loop body for as long as the test holds true (= a do until loop).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.
A plugin entity, either scoped to a particular client or to the system.
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.
A plugin that lets you add additional properties to forms, which can be configured in the form designer via the forms
tab in the properties panel on the right-hand side.
Parameters for the plugin that lets you add additional properties to a form.
Result returned by form properties extension plugins.
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.
Deprecated.
This plugin type only allows plugins to provide a single resource, and only either a CSS or JavaScript
file.
Describes a resource that a form resources plugin wishes to provide for web forms.
Parameters for the method of a form resource plugin that retrieves the data of the resource.
Interface for plugins that wish to add additional frontend resources that are available for web forms.
Parameters for the getResources method of a form resources plugin.
A plugin that lets you provide additional
IFormTheme.The parameters that are given to
IPluginFormTheme.Interface for the value returned by
IPluginFormTheme.Interface for a generic plugin.
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.
Parameters for the HTML template callback plugin.
Return value of the callback invoked after an HTML template was rendered.
Represents the result when the properties of a plugin were validated.
Event that is fired during various phases of a plugin's lifecycle, before and after a single
IFCPlugin is
installed, activated, deactivated, or uninstalled.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.
Common interface for a custom logout 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.Base plugin interface for an extension of the core message service configuration.
Parameters for the message service extension to determine whether it is
available.Common interface for backing beans for panels of
message service extensions.Parameters that are passed to the
initialize method of the backing bean of an extension of the
message service configuration.Parameters for an extension of the message service configuration to determine whether it is
collapsed.The parameters that are passed to
IPluginMessageConfigExtension.getDefaultConfigModel(IPluginMessageConfigExtensionDefaultModelParams)The parameters that are passed to
IPluginMessageConfigExtension.getNewConfigModel(IPluginMessageConfigExtensionNewModelParams)Parameters for an extension of the message service configuration to determine whether it is
toggleable.Plugin interface for sending and receiving messages from an external message service.
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).Deprecated.
This is part of the old workflow engine that will be removed soon.
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.
Interface for custom GUI beans provided by prompt service plugins that are intended to be used for the prompt
connection configuration.
Interface for custom GUI beans provided by prompt service plugins that are intended to be used for the prompt query
configuration.
A plugin that lets you add a new prompt services to formcycle.
Common interface for the return value of a plugin.
Event that is fired when a new plugin runtime with one or more plugins was registered.
Event that is fired when a new plugin runtime with one or more plugins was released.
This interface marks an
IFCPlugin to only be initialized in Client scope.This interface marks an
IFCPlugin to only be initialized in SYSTEM scope.Common interface for the file data of a form record message attachment.
Marker interface that defines the recipient when sending a form record message via an external message service.
Common plugin interface that defines the recipient when sending a form record message via an external message to a
user's inbox.
Common plugin interface that defines the recipient when sending a form record message via an external message service
as an
authenticated user.Common plugin interface for sending a form record message to a recipient via an external message service.
The response to a message send request.
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.
Mixin meant for
IPluginWorkflowNode plugins that only wish to provide a workflow while loop that runs a test
and executes the loop body for as long as the test holds true (= a while loop).Interface for workflow node plugins.
Interface for custom GUI beans provided by workflow node plugins.
Interface for workflow trigger plugins.
Interface for custom GUI beans provided by workflow trigger plugins.
High-level methods for retrieving available user portals.
Deprecated.
Data access object for creating, updating, and deleting
Postfach entities.The Class PostfachHandler.
Deprecated.
This is part of the old rest API.
Basic data for posting a
form record message, e.g. from an external context or from a
frontend server via the API provider.Data returned when a
IPostFormRecordMessageRequest is executed.Deprecated.
Interface for a callback before a bean is initialized.
Parameters passed to a
prompt connection bean when a connection is selected, see
prepareViewForConnection.Parameters passed to a
prompt query bean when a query is selected, see
prepareViewForQuery.Interface to be used in conjunction with
PreRenderViewActionListener, to make it easier for a component to
listen to a PreRenderViewEvent.Abstraction for formatting temporal objects (like dates and times) into localized strings.
Builder for formatting a temporal object (like a date or time) into a localized string, see
IPresetTemporalFormatter.Callback interface for updating process data within this container
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.DAO for reading and writing
ProjectPortalConfig entities.Data access object for creating, updating, and deleting
ProjectPortalData entities.DAO for reading and writing
ProjectPortalTag entities.Handler for
ProjectPortalTag 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.Result of a bulk update operation.
Parameters for a bulk update of form records based on a project.
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.
Parameters for computing the input parameter descriptors of a prompt query, see
computeQueryInput.The return value of
handler.computeQueryInput.Parameters for computing the output parameter descriptors of a prompt query, see
computeQueryOutput.The return value of
handler.computeQueryOutput.Internal interface used by
PromptConfigJsonMarshaller to pass the logic for post-processing prompt configs
after they have been deserialized from JSON.Internal interface used by
PromptConfigJsonMarshaller to pass the logic for updating prompt configs from
older versions to the current version.Base interface for GUI beans that manage prompt connections.
Mixin for a
prompt query configuration model that allows the user
to configure the API key, i.e. the token needed to authenticate with the prompt service provider.Mixin for a
prompt query configuration model that allows the user
to configure the API URL, i.e. the URL of the prompt service provider.Mixin for a
prompt query configuration model that allows the user
to configure the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider)
to be established.Mixin for a
prompt query configuration model that allows the user
to configure the model, i.e. the name of the model to use for the prompt service.Mixin for a
prompt query configuration model that allows the user
to configure the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after
sending a request.Result of analyzing a prompt connection export.
Specification for analyzing a prompt connection export file.
Model representing metadata about an exported prompt connection.
Specification for exporting a prompt connection, including the prompt connection identifier and an optional password
for encryption.
Service that provides common logic needed when executing prompt queries.
Context used during execution of a prompt query.
A replacer that replaces placeholders in an object graph of prompt models.
Builder for a replacer that replaces placeholders in an object graph of a prompt model.
Input parameters for executing a prompt query, see
executePromptQuery.Replacer for placeholders within strings, used during prompt execution.
A replacer bound to specific settings, allowing multiple replacements with the same configuration.
Resolver for context placeholders.
Escaper for replaced values, used during prompt execution.
Builder for a replacer that can replace placeholders in strings, used during prompt execution.
Represents the result of resolving a files configuration into actual files, see
IPromptExecutionResolveFilesBuilder.build().Builder for resolving a files configuration into actual files.
Builder for resolving text parameters.
The return value of
handler.executePromptQuery.Result of analyzing a prompt export file.
Model representing metadata of a prompt export.
Builder for the file parameters descriptor of a prompt query.
Storage used during prompt execution to store binary data.
A writer that writes binary data to an output stream.
Converter that computes a new alpha channel operation based on whether the image has an alpha channel or not.
A builder for a converter that can post-process images.
A converter that can post-process images.
Computes the new format of an image, based on its current format.
Computes the new geometry of an image, based on its current width and height.
Represents metadata of an image, such as its size or format.
Service for working with images in relation to prompt services, e.g. transforming images before they are sent to a
prompt service; or after they were received from a prompt service.
Builder for the JSON answer descriptor of a prompt query.
Service for prompt service providers that provides functionality related to JSON schemas.
Service with various operations for managing prompt connections and queries, mainly CRUD operations.
Service with logic related to prompt input and output parameters, such as
PromptTextParameter or
PromptFileSetParameter.Base interface for GUI beans that manage prompt queries.
Builder for configuring a
EWorkflowNodeType.FC_PROMPT_QUERY action.Mixin for a
query connection configuration model that allows
the user to configure whether a watermark should be added to generated files (such as images).Mixin for a
query connection configuration model that allows
the user to configure whether the prompt service may perform web searches when executing a prompt query.Mixin for a
prompt query configuration model that allows the user
to define the aspect ratio, such as e.g. 16:9 or 4:3.Mixin for a
prompt query configuration model that allows the user
to define the format of generated audio files, such as e.g. mp3 or wav.Mixin for a
query connection configuration model that allows
the user to enter an optional candidate token limit, often referred to as "top-k".Mixin for a
query connection configuration model that allows
the user to enter an optional cumulative probability threshold for nucleus sampling, often referred to as "top-p".Mixin for a
prompt query configuration model that allows the user
to define the resolution of generated image or video files, such as e.g. 512x512 or 256x256.Mixin for a
prompt query configuration model that allows the user
to define amount of effort the prompt service should put into answering the prompt, sometimes also referred to as
"reasoning effort" or "thinking level".Mixin for a
query connection configuration model that allows
the user to configure whether the prompt service may enhance the user's prompt.Mixin for a
prompt query configuration model that allows the user
to configure files for the prompt query, by uploading a list of static files and/or by defining a list file set
parameters accepted by the query.Mixin for a
query connection configuration model that allows
the user to a frequency penalty when executing a prompt query.Mixin for a
query connection configuration model that allows
the user to enter the number of tokens the model should generate at most in its response to the prompt.Mixin for a
prompt query configuration model that allows the user
to define the background of generated image files, such as e.g. opaque or transparent.Mixin for a
prompt query configuration model that allows the user
to define the compression quality of generated image files, if the image format supports compression, as a percentage
value from 0% to 100%.Mixin for a
prompt query configuration model that allows the user
to define the format of generated image files, such as e.g. png or jpeg.Mixin for a
prompt query configuration model that allows the user
to define the language of the input text or files that are passed on to the prompt.Mixin for a
prompt query configuration model that allows the user
to define a JSON schema for the prompt response.Mixin for a
prompt query configuration model that allows the user
to define how many media files such as images or voice clips should be generated.Mixin for a
prompt query configuration model that allows the user
to define the speed at which a media (e.g. speech or music) file should be generated.Mixin for a
prompt query configuration model that allows the user
to define the language of the output text or files that are returned by the prompt.Mixin for a
query connection configuration model that allows
the user to a presence penalty when executing a prompt query.Mixin for a
query connection configuration model that allows
the user to enter seed when executing a prompt query.Mixin for a
query connection configuration model that allows
the user to configure whether the query accepts an audio file as a file
input parameter.Mixin for a
query connection configuration model that allows
the user to configure whether the query accepts an image file as a file
input parameter.Mixin for a
query connection configuration model that allows
the user to configure whether the query accepts an pdf file as a file input
parameter.Mixin for a
query connection configuration model that allows
the user to configure whether the query accepts an text file as a file input
parameter.Mixin for a
query connection configuration model that allows
the user to configure whether the query accepts an video file as a file
input parameter.Mixin for a
query connection configuration model that allows
the user to enter an optional system prompt message.Mixin for a
prompt query configuration model that allows the user
to select a type of task that the query should perform.Mixin for a
query connection configuration model that allows
the user to enter an optional temperature.Mixin for a
prompt query configuration model that allows the user
to define a list text parameters accepted by the query.Mixin for a
prompt query configuration model that allows the user
to define the format when transcribing speech to text, such as e.g. plain text or subtitles.Mixin for a
query connection configuration model that allows
the user to enter a user prompt message.Mixin for a
query connection configuration model that allows
the decide whether the model should use sampling or greedy decoding when generating text.Mixin for a
prompt query configuration model that allows the user
to define the format of generated video files, such as e.g.Mixin for a
prompt query configuration model that allows the user
to define the name or ID of a voice to use when synthesizing speech.Result of analyzing a prompt query export.
Specification for analyzing a prompt query export file.
Model representing metadata about an exported prompt query.
Represents a file attached to a prompt query.
Specification for exporting a prompt query, including the prompt query identifier and an optional password for
encryption.
Result of importing a prompt query.
Specification for importing a prompt query.
The input descriptor that defines the structure of the data that passed to a prompt query upon execution.
Base interface for input and output descriptors that define the structure of the data passed to a prompt query upon
execution and the data returned from a prompt query upon execution.
Base interface for all prompt query I/O objects, i.e. request and response objects.
The output descriptor that defines the structure of the data that returned when executing the prompt query.
Interface for classes that provide prompt query parameters.
Interface for classes that provide a reference to a prompt query.
A single parameter value passed to a prompt query upon execution, see
handler.executePromptQuery.A single value returned when executing a prompt query, see
handler.executePromptQuery.A reference to a prompt object, such as a prompt connection or prompt query.
Service interface for finding references to prompt objects, such as connections and queries.
Handler interface for a prompt service that allows for natural language or media data queries, backed by technologies
such as large language models (LLMs) or image generation models.
Low-level registry for
prompt service handlers.The ID of a plugin that provides a prompt service, used by
IPromptServiceHandlerRegistry.A reference to a specific type of prompt service.
Represents the result of
IPromptFileStorage.storeBinaryData(InputStream), i.e. stored binary data, together
with the size of the stored data.Represents the parameters of a prompt connection test, see
testConnection.Represents the return value of a prompt connection test, see
testConnection.Builder for the text answer descriptor of a prompt query.
Builder for extracting
prompt text parameters from a given configuration object.Builder for the text parameters descriptor of a prompt query.
Service with various operations on a given
type of of prompt services.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.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
Deprecated.
Implement
IElementHandler.readObjectReferences(IReadObjectReferencesParams) instead.Query interface for getting object references, passed to
IElementHandler.readObjectReferences(IReadObjectReferencesParams)Models the parameters that are passed to
IElementHandler.readPlaceholders(IReadPlaceholdersParams).The result of an encryption attempt for a specific recipient, including whether the encryption was successful and any
exception that occurred if it was not.
A member (property, key-value pair) of a record value as described by a
IRecordValueDescriptor.A
IValueDescriptor for a record value, i.e. a Map with a certain shape.A builder for a
IRecordValueDescriptor.Common interface representing an action to redirect.
Wrapper for a
IFormTheme together with a reference to that form theme.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.
See
IExecutionResultDescriptor for more details.Parameters with data passed to the various methods of
IRefinedExecutionResultDescriptor.See
ITriggerDataDescriptor for more details.Similar to the
IEventExecutionResult, but with slightly different info so that it can be sent to the frontend
server.Deprecated.
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.
Data for adding an upload request to a form record message.
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.A
IResolvedFileSourceDetails for files created by a previously executed trigger.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.Common interface for resources provided by the REST API.
Interface for enforcing access control to a resource specified by a URI or URL.
Interface for reading resource bundles.
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.
Mapper for resource links returned by the user portal rest API.
A function that opens a resource and may throw an exception in doing so.
Common interface for a page of resources.
A resource store manager.
Manages values associated with a certain type of key.
Manages values associated with a certain type of key.
Same as
IResourceStoreManager.IResourceStore, but with a bound loader that does not need to be specified each time when
requesting a value for a key.Manages values associated with a certain type of key.
Manages values associated with a certain type of key.
Same as
IResourceStoreManager.IVersionedResourceStore, but with a bound loader that does not need to be specified each time
when requesting a value for a key.Same as
IResourceStoreManager.IVersionedResourceStore, but with a loader and bound version extractor that do not need to be
specified each time when requesting a value for a key.Same as
IResourceStoreManager.IVersionedResourceStore, but with a bound loader that does not need to be specified each time
when requesting a value for a key.Same as
IResourceStoreManager.IVersionedResourceStore, but with a bound version extractor that does not need to be specified
each time when requesting a value for a key.Same as
IResourceStoreManager.IVersionedResourceStore, but with a bound version extractor that does not need to be specified
each time when requesting a value for a key.Interface for global, mostly technical, configuration for the REST client.
Base interface for providing REST services via SPI.
Mixin for nodes that neither return a result nor do throw an error.
Parameters for
prepareViewForConnection.Return value of
retrieveConnectionModel.Parameters that are returned from to
IElementPropertiesBean.retrieveCurrentProperties(Object) when the
workflow element is stored or saved.Parameters for
prepareViewForQuery.Return value of
retrieveQueryModel.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.
Contextual data required to route to a specific URL.
A routing context that requires the portal alias.
Interface for RSA key pair generation specifications.
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.Accessor (getter+setter) for the scope of an object.
A persistence adapter for entities that are scoped to a certain context, such as a client or project.
Common interface for the metadata of a scoped file.
Common interface for scoped localized database objects.
Common interface for all objects (mainly entities) that provide localized data for different scopes.
Getter for the scope of an object.
Setter for the scope of an object.
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.Builder for configuring a send portal message node.
Result with information regarding a mail sending operation, see e.g.
Common interface for form record message attachments.
Common interface for form record messages.
Marker interface that defines the recipient when sending a form record message.
Common interface that defines the recipient when sending a form record message service as an email.
Common interface that defines the recipient when sending a form record message to a user's inbox.
Common interface that defines the recipient when sending a form record message service as an
authenticated user.Common interface for the request to send message.
Common interface for the response to send message.
Common interface for the data of a form record messsage upload request.
Information about a mail that was sent by
IMailContext.send(IBaseMailData, Mandant).Implements
ICustomParametersUpdateable.updateCustomParams(IUpdateCustomParametersParams) by running the transitions
(upgrades) between the previous and the current version.A
BiConsumer that is also serializable.A
BiFunction that is also serializable.A
BiPredicate that is also serializable.A
Consumer that is also serializable.Represents a serializable reference to a single file.
A
Function that is also serializable.An
IInputStreamSupplier that is serializable.Markup interface for model classes that may be serialized to JSON (using GSON and
InterfaceSerializerTypeAdapter).Common interface for a page of
serializables.A
Predicate that is also serializable.A
Supplier that is also serializable.A
BiFunction that is also serializable and can throw exceptions.A
Supplier that is also serializable and can throw exceptions.A
Runnable that may throw a checked exception and is serializable.A
Supplier that is also serializable and can throw exceptions.A
UnaryOperator that is also serializable.Common interface for server configurations allowing access to server settings and features.
Common interface for GUI server models.
Interface for server properties.
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.Deprecated.
This was used as part of the old workflow.
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.Builder for configuring a
EWorkflowNodeType.FC_SET_FORM_RECORD_PASSWORD action.Builder for configuring generated password settings.
Represents a shaped text.
Builder for a
shaping text wrapper.Interface for configuring a
shaping text wrapper.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 nodes that are
ISingleNodePrototype and additionally use a properties model that extends from
BaseDoUntilLoopProps.A mixin for all triggers that are
ISingleTriggerPrototype and additionally use a properties model that
extends from BaseTriggerProps.A mixin for all nodes that are
ISingleNodePrototype and additionally use a properties model that extends from
BaseWhileLoopProps.Mixin that extends
ISingleNodePrototype for builtin node types.Mixin that extends
ISingleTriggerPrototype for built-in trigger types.Builder for configuring a
single condition.Interface for POJOs with the parameters for
SingleConditionEvaluator.test(ISingleConditionData).A function that produces is given a
single condition builder and must use that
builder to create a single condition.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.Interface for beans that track changes in their state.
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.Represents a part of a BPMN model for a workflow node or trigger.
A builder for a
IStructuredBpmnModelPart, associated with a particular IWorkflowBpmnModelContext.A child of a
IStructuredBpmnModelPart, see IStructuredBpmnModelPart.childParts().A graphviz style for graphs, nodes, or edges.
/** Represents a laid out
SubProcess that may have a visible text annotation, a
visible name, and a start and end event.Base for specific
IValueBuilder.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.
A
file system that is synchronized.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.
Used internally by the
EWorkflowNodeType.FC_FOR_EACH_LOOP to represent the items over which to iterate,
depending on the selected EForEachLoopItemListSource.A builder for a single item of an iteration.
An item list used internally by the
FC_FOR_EACH_LOOP workflow node to
represent the resolved the items for the selected EForEachLoopItemListSource.Extends the
ItemListModel and adds functionality for memorizing the currently selected entity for the
duration of the current session.Common interfaces for representing template data
Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use
XIterableUtils.Deprecated.
Describes the parameters for a test connection call to a prompt query, see
IPromptTypeService.testConnection(IPromptServiceType, ITestPromptConnectionParams, Object)Describes the return value of a test connection call to a prompt query, see
IPromptTypeService.testConnection(IPromptServiceType, ITestPromptConnectionParams, Object).Refactor handler for plain text resources.
Interface for shaping text.
Interface for a text wrapper that can wrap text into lines based on the specified font size and text direction.
A
BiConsumer that may throw a checked exception.A
BiFunction that may throw a checked exception.A
Consumer that may throw a checked exception.A
Function that may throw a checked exception.A
Runnable that may throw a checked exception.A
Supplier that may throw a checked exception.A
UnaryOperator that may throw a checked exception.Interface representing the context for testing TLS connections based on an
SSLContext.Resolver for TLS scopes based on connection identifiers.
Interface for token adapters.
Interface for the token endpoint.
Common interface for responses to a refresh token request.
Interface for
TabModels that provide additional entries to the top menu header.Deprecated.
Needs to sit in a JPMS module for proper use.
Basisschnittstelle für alle ID-basierten Modellklassen.
Interface for treating an item as a node in a tree-like structure.
Deprecated.
Use
ITreeAccessor.Interface for treating an item as a node in a tree-like structure.
Deprecated.
Use
ITreeParentAccessor.Interface for accessing the children of tree nodes, together with the data associated with each tree node.
Deprecated.
Use
ITreeWithDataAccessor instead.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.
Data returned when a workflow execution was triggered implicitly due to some requested action.
Represents the parameters for
ITriggerHandler.getFilterCriteriaForEvent(ITriggerFilterCriteriaForEventParams).All trigger handlers must be thread-safe.
Interface for workflow trigger like objects that have got a
TriggerKey identifying them.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.A
Supplier that may throw a single typed checked exception and is serializable.A
Consumer that may throw a single typed checked exception.A
Function that may throw a single typed checked exception.A
Supplier that may throw a single typed checked exception.A workflow element with a type, such as a trigger or node.
Deprecated.
use
IUncacheableFileMarkup-Interface for files which shouldn´t be cached
Base type for all graph dot statements that can be used in undirected graphs.
Represents the event data of an error event that is triggered when an unhandled exception occurred during workflow
execution.
A constructor that can create a new instance of a type, requiring a single parameter.
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 an upload element.
(Workaround to enable the postprocessing of uploads outside of fc-form-common)
Declares functionality for upload verification.
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 entitiesCommon interface for accessing the data of a user.
Deprecated.
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.A builder for a new event of type
EWorkflowTriggerType.FC_USER_INVOCATION that occurs when a portal user
initiates it.DAO interface for reading and writing
UserMfaTempToken entities.Interface for checking user permissions.
DAO for reading and writing
UserPortalAuthConfig entities.Handler for
UserPortalAuthConfig entitiesCommon interface for chat entry view models.
Interface for global, mostly technical, configuration for the portal frontend.
DAO for reading and writing
UserPortal entities.Handler for
UserPortal entitiesContext with all data required to make a call to the user portal REST API.
Represents the result of a user portal API method.
Configuration for the user portal REST API client.
A URL route of the user portal.
Handles URLs for the user portal.
Common interface for a user that is authenticated via the user portal.
Common interface for a manager that handles the user portal session.
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 referencing and identifying a user.
Common interface for user reference resolvers that help with identification of users defined by their user
reference.
Interface for further user reference data which is only used for filtering.
High-level methods for authenticating and authorizing a user and retrieving details about a user.
Handler for
UserRefreshToken entitiesInterface for all entities that are identified by a UUID (universal unique identifier).
Interface for objects that have got a UUID identifying them.
Common interface for UUID resources provided by the REST API.
Interface for defining acceptance criteria for values, used by
IValueDescriptor.acceptsValue(Object, IValueAcceptanceCriteria).Interface for accessing a value, combining a getter and a setter.
Base interface for builders that can create a value of a certain type.
Configurator for a set of
IValueBuilderOptions, for use with the
builder obtained from a IValueDescriptor.Options for a value builder that lets you create a value conforming to a
IValueDescriptor.Base interface for builders that can configure 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.
Interface for a value descriptor.
Base class for all value descriptors that describe the shape of (mostly JSON-like) data.
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 coercer that attempts to coerce values to their expected type, as given by a
IValueDescriptor.Matcher for the actual type of
IValueDescriptor.A predicate on an edge of a
ValueGraph.Accessor for the structure of JSON-like values.
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
Common interface for view menu entries.
Deprecated.
since 8.0.0 Use
IView instead.mark-up-interface for virtual entities
A virtual node in the flow graph that does not correspond to an existing
WorkflowNode.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.
Interface representing the context of a web application.
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 web endpoint providers.
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.Builder for configuring a with form element context workflow action
(
FC_WITH_FORM_ELEMENT_CONTEXT).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().Selector for an in and out ports of the
IWorkflowBpmnAlignmentItem created by
IWorkflowBpmnLayoutAlignAroundBuilder.Selector for an in and out ports of the
IWorkflowBpmnAlignmentItem created by
IWorkflowBpmnLayoutAlignAtAxisBuilder.An alignment item used when modeling workflow elements for a BPMN diagram.
Selector for points to use when aligning
alignment items in a BPMN model via
IWorkflowBpmnLayouter.alignAtAxis().Represents the result of
IWorkflowBpmnAssociationEdgeBuilder.build(), with an edge and an association.Builder for creating an
Association and a BPMN edge between a source and a target, used by
IFlattenedAlignmentItemMap.association().Builder for creating a
BPMN edge for an association-like connection between a source and a target,
used by IFlattenedAlignmentItemMap.association() and IFlattenedAlignmentItemMap.dataAssociation().Selector for the spacing to use when aligning
alignment item in a
cardinal direction, e.g. via alignAtAxis or
alignAtPorts.Helper to colorize BPMN shapes, edges, and labels.
Base builder interface for creating connections (such as
Association or SequenceFlow) and a
BPMN edge between a source and a target, used by IFlattenedAlignmentItemMap.Builder for creating a
BPMN edge for a DataAssociation between a source and a target, used
by IFlattenedAlignmentItemMap.dataAssociation().The data store that provides access to custom data associated with the current BPMN model context.
Store to access various contextual entities that might be referenced by the workflow when building a BPMN diagram,
such as client or form files.
Represents the result of
IWorkflowBpmnFlowEdgeBuilder.build(), with an edge and a flow.Builder for creating a
SequenceFlow and a BPMN edge between a source and a target, used by
IFlattenedAlignmentItemMap.flow().Configurator for the label alignment on a flow line, used by
IWorkflowBpmnFlowEdgeBuilder.name(IWorkflowBpmnAlignmentItem, IWorkflowBpmnFlowEdgeNameConfigurator)A BPMN interconnection between
WorkflowBpmnPointRef.Data for a BPMN interconnection between
WorkflowBpmnPointRef.A builder for aligning two items, with the second item positioned relative to the first item.
Builder for configuring the settings when aligning multiple elements in a BPMN diagram.
Builder for aligning items in the
flow direction, see
IWorkflowBpmnLayouter.alignAtPorts().Builder for layouts that allow setting the alignment in the cross-axis when computing the layout.
Builder for aligning an item (such as a
label) on the left or right side of (the edge of) a sequence flow or message flow.Options for aligning an item on the left or right side of (the
edge of) a sequence flow or message flow.Interface for layout builders of BPMN elements that can have text annotations.
Builder for layouts that allow setting the
axis polarity in which to align the items.Builder for layouts that allow setting the coordinate axis and axis direction in which to align the items.
Builder for layouts that allow setting the axis in which to align the items.
Builder for the layout of a BPMN
DataObjectReference.Builder for the layout of a BPMN
DataStoreReference.Layout helper that can be used to lay out the BPMN diagram, such as aligning the parts of a workflow node in a
sequence.
Builder for the layout of a BPMN
Event.Builder for the layout of a BPMN
Gateway.Builder for layouts that allow setting an ID used as the value to identify the item.
Interface for layout builders of BPMN elements that can have a name that gets placed somewhere in the
BpmnDiagram.Interface for layout builders of BPMN elements that can have an external name that gets placed outside the element,
such as
Event or Gateway.Builder for configuring the settings when padding an alignment item.
Builder for layouts that allow setting the port direction of the final alignment item.
Builder for layouts that allow setting a primary intercardinal direction for aligning the items.
Layout settings that affect how the BPMN diagram for the workflow is created.
Builder for layouts that allow setting the spacing between items.
Builder for layouts that allow setting the spacing between items via a custom selector function.
Builder for the layout of a BPMN
SubProcess.Builder for the layout of a BPMN
Task.Interface for the context available when a workflow flowchart is converted to a BPMN diagram.
Accessor the points of an
IWorkflowBpmnAlignmentItem, used by the WorkflowBpmnAlignmentItemBuilder.Represents the
BPMN shapes created for the start and end event of a
IBoundedBpmnElementLayout.An
alignment item with exactly two children.Base interface for building a workflow element (node or trigger).
Base DAO for all workflow elements.
Interface for workflow elements that behave differently depending on their type.
Registry for all workflow element handler.
Provides access to all workflow elements of a workflow when creating a BPMN diagram.
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 affecting how the workflow is executed.
A single file provided by a workflow trigger or node.
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 provided by a workflow element. such as the files provided by a trigger or the files
created by a node when executed.
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.
Interface for instances that can provide or contain a
INodeExecutionData.Interface for modeling
workflow nodes in a BPMN 2.0 diagram.Builder for
IStructuredBpmnModelPart instances created from workflow nodes.Data access object for creating, updating, and deleting
WorkflowNode entities.Analyzes how a workflow node can be executed, in a manner similar to solving data flow equations.
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.
Interface for modeling
workflow processes in a BPMN 2.0 diagram.Builder for
IStructuredBpmnModelPart created from workflow processes.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).Wrapper class with all details for
INodeExecutionParams.softError(String, String, IValueCreator, Throwable)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.
Interface for modeling
workflow tasks in a BPMN 2.0 diagram.Builder for
IStructuredBpmnModelPart created from workflow tasks.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.
Interface for modeling
workflow events in a BPMN 2.0 diagram.Builder for
IStructuredBpmnModelPart instances created from workflow triggers.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.
Handler for locating triggers when a task is executed.
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.Deprecated.
Implement
IElementHandler.writeObjectReferences(IWriteObjectReferencesParams) instead.Query interface for providing information for updating entity references, passed to
IElementHandler.writeObjectReferences(IWriteObjectReferencesParams).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.
Deprecated.
This is part of the old REST API that will be removed soon.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Adapter for the API client that integrates with a Jax RS implementation.
Simple builder for configuring a JaxRS RestEASY adapter.
Simple builder for configuring a JaxRS RestEASY adapter.
Simple builder for configuring a JaxRS RestEASY adapter.
Simple builder for configuring a JaxRS RestEASY adapter.
Simple builder for configuring a JaxRS RestEASY adapter.
Simple builder for configuring a JaxRS RestEASY adapter.
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
Enables JSF 2.3 features.
Deprecated.
Represents the result of a JSF validation phase.
Responder-Implementierungen für JSON zur Request-Verarbeitung und/oder Response-Befüllung.
An
IValueAccessor for the single JSON parameters of a FcPromptQueryProps.Helper for working with JSON patches according to as specified by https://tools.ietf.org/html/rfc6902.
Simple builder for a JSON path.
Converts between a JSON object and a list of entries, where each entry represents a primitive value in the JSON
object.
Builder for
JsonPathEntryConverter.Converts objects to a Map of JSON path value pairs and back.
Helper class for JSON paths.
The quoting style for JSON path string literals.
Übergebenen JSON-Daten vom Typ JSONObject in Liste von ValueDescriptoren umwandeln
PrimeFaces component for the JsonSchemaEditor component.
PrimeFaces component (renderer) for the JsonSchemaEditor component.
View model POJO for users to define a JSON schema for the prompt response.
View model POJO for users to define a JSON schema for the prompt response, by entering a JSON example.
View model POJO for users to define a JSON schema for the prompt response, by entering the JSON schema manually.
View model POJO for users to define a JSON schema for the prompt response, by entering a list of properties for the
object.
View model POJO for users to define a JSON schema for the prompt response, by using a visual JSON schema editor.
One of the properties of a JSON object schema, used in
JsonSchemaOutputByPropertyList.Generic exception for JSON processing errors for the JSON Schema service.
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.KERBEROSModel 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.Factory class for creating key pair generation specifications.
Bean for handling the administration of keystores and their entries.
Provides the keystore administration view for the web application.
An email-encryptor key-provider to determine the certificates by a keystore.
Specification for importing an entry of a key store.
Model for detailed information about an issue with a key store entry.
Mapper for
KeyStoreEntryIssueDetailModel.Validator for keystore entry passwords.
Selector for keystore entries when starting an import process.
Enum representing the types of how keystore entries can be selected for automatic import processes.
View model for certificate usages.
Bean for exporting a keystore.
Represents an entry in a keystore that is to be imported.
Keystore layout for the import process.
Parameters for starting the import process of keystore files.
A DTO that contains information about a key store.
Interface that defines the operations for managing keystores within the XIMA formcycle certificate module.
Model class representing the scope of a keystore.
Model for selecting a keystore.
View model for keystores.
Model class for identifying a known mail server.
Types of mail sender scopes.
How to handle labels for bean validation.
Use a custom label.
Include the default label, see
Label.Do not include the label, see
Label.Represents a label string, either plain text or HTML.
View model for layout settings related to
lanes in BPMN diagrams.Mostly dummy
IXFormRenderConfig that only implements LanguageFd2Config.getLanguageProvider().Wrapper for reading a string lazily, e.g. from a file.
Login interceptor that stores the time of the last login in the
Mandant.getLastUserLogin() property.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.This model is used to display the form cards in a lazy way.
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.Model class for the properties of an authenticator of type
EAuthClientType.LDAP.Deprecated.
Deprecated.
Bean für die Verwaltung von Verbindungen
Provider for the LDAP connections available in the current client during workflow editing and validation.
Model representing the configuration for an LDAP connection.
The type of TLS scope.
Factory class for creating instances of
LdapConnectionConfig.Factory for creating LDAP connections for authentication clients.
Deprecated.
Use
ILdapService instead to create LDAP connections.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
Legacy converter for the PrimeFaces
p:colorPicker component.A length with some intrinsic unit for graphviz attribute values.
The
MeasurementUnit for a length or distance.A
Length with the intrinsic unit inches.Factory for creating length values in various different units.
A
Length with the intrinsic unit points.A list of length values.
A factory for creating
LengthList from values in a given unit.A graphviz 2D or 3D point with a length unit. 3D is valid only when the attribute
dim is set to 3.A factory for creating
LengthPoint from values in a given unit.Common units of length.
Model that combines a system and a client license.
Factory for creating
license authorizers.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
Deprecated, for removal: This API element is subject to removal in a future version.
Implements
IResourceAccessControl with a blacklist and whitelist.Simple builder for configuring a
ListedResourceAccessControl instance.Base class of a
Control for a list item container, either the start or end of a list.A
Control that represents the start of a list item container.Model class for the for-each loop, representing the settings when
EForEachLoopItemListSource.JSON_VALUE is
selected.Model class for the for-each loop, representing the settings when
EForEachLoopItemListSource.CHARACTER_SEPARATED_VALUES is selected.Model class for the for-each loop, representing the settings when
FIELD_VALUES is selected.Model class for the for-each loop, representing the settings when
EForEachLoopItemListSource.JSON_VALUE is
selected.Model class for the for-each loop, representing the settings when
EForEachLoopItemListSource.FORM_FIELD_REPETITIONS is selected.Model class for the for-each loop, representing the settings when
EForEachLoopItemListSource.JSON_VALUE is
selected.Model class for the for-each loop, representing the settings when
EForEachLoopItemListSource.ROWS_OF_CHARACTER_SEPARATED_VALUES is selected.A
Control that represents the start of a list item container.A read-only list that combines two lists into one, effectively concatenating them.
An unmodifiable list that extends another list and includes an additional item at the end.
A
IUpdateTransition composed of multiple individual .transitions.A read-only list that excludes a specific item at a given index from another list.
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.
CDI qualifier for the local address.
Deprecated.
This is called
LocalDateTimeConverter, but behaves as if it were a LocalTimeConverter.Bean des aktuellen
LocalesHelper class for localization.
Composite, embeddable ID class for
entity localizations.Base view model for the localization of a portal-related object.
Base view model for the localization of a portal-related object.
A 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.
Represents an item that is locked by a specific lock.
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
LoginPage
This class represents the view model for the login page.
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
Implementation of
IMailEncryptionResult.The Class MailHandler.
Model class representing mail data.
Factory for creating email security instances to be used for email encryption and/or signature by a given type
Implementation of
IMailSecurityReport.Utility class for sending mail.
Service interface for mail operations.
Implementation of the MailService interface which may be used on frontend and master servers.
Implementation of
IMailSigningResult.Common mail utils.
DOM node representing the main element.
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.
Represents the manifest information of a JDBC driver.
Mapper for converting
Manifest to ManifestInfo.Base class of a
Control for a map entry container, either the start or end of a map entry.A
Control that represents the end of a map entry container.A
Control that represents the start of a map entry container.An accessor for a single value in a map.
An
InputStream that is always empty and markable / resettable.Extends the
RandomAccessFileInputStream to provide support for MarkableRandomAccessFileInputStream.mark and MarkableRandomAccessFileInputStream.reset().Deprecated.
Use
MarkableRandomAccessFileInputStream instead.The
MeasurementUnit for a mass.Common units of mass.
Constraint validation that may be applied to
TimeDuration.Defines several
MaxTimeDuration constraints on the same element.Validator implementation for the
MaxTimeDuration constraint.Represents a unit of measurement, such as length, weight, or time.
Deprecated.
Deprecated.
Use
MainMenuBean instead.Deprecated.
The
MenuTemplateBean has been deprecated.View model for an
Attachment of a FormRecordMessage in the inbox.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.Factory and other utility methods for
IMessageLocalizer and IBoundMessageLocalizer.Message model class with builder pattern.
Helper class for message properties.
Metadata for a builtin localizable text property.
Factory class for creating instances of
IMessageService.CDI Producer for message services
MessagesPage
View model for a
FormRecordMessage to display in the chat.Deprecated.
This is part of the legacy REST API that will be removed at some point.
Interface for the metrics registry.
Model representing the result of sending an MFA email code.
Filter that checks user profile for possibly multi factor authentication and initiates it if required.
MfaSettingsResponse
DTO for
IMfaSettingsModel representing a response indicating that two-factor authentication is required.
Model representing a response indicating that two-factor authentication is required.
Model representing a response indicating that two-factor authentication is required.
MfaVerificationResponse
Model representing the result of a multi-factor authentication (MFA) verification.
Creates LDAP connections for all
MandantLdapData and connects them with appropriate LDAP queries or actions.Migration of keystores from the filesystem to the database for FrontendServer entities.
Deprecated.
Before version 8.0.4, references to user groups in the form designer used the name of the user group.
Deprecated.
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
A
IValueDescriptor for a mime type, consisting of the components of a mime type (a main type, a subtype, and
an optional set of parameters).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.Exception thrown when executing a prompt query for which no prompt service implementation could be found.
Builder for mock form requests that can be used in unit tests.
A
Deque that keeps track of the number of modifications made to it.A map that keeps track of the number of modifications made to it.
A set that keeps track of the number of modifications made to it.
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.
Profile creator for Azure AD logins using the OAuth 2.0 access token and the MS Graph API.
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
Deprecated.
use
MsGraphAuthorizationGenerator insteadDeprecated.
Use
MsGraphProfileCreator instead.Implementation of
IHandlerProvider for the master server.MBean implementation of
MSMonitorMBean for querying certain information about the master server, and to
trigger certain actions.API for accessing properties of the properties file on the master server.
Default implementation of the
IMsPropertiesHandler interface.Implementation of the
RpcHandlerProducer on the master server.Deprecated.
Helper class for accessing MS system properties.
Class for setting up the master server security.
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.Deprecated.
Use a
GroupSequenceProvider instead.Defines several
MultiAttachmentSizeIf constraints on the same element.Deprecated.
Use a
GroupSequenceProvider instead.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.Backing Faces component class for the
<xp:multiFile /> composite component.View model for a multi file control in the prompt query action editor.
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.Deprecated.
Use a
GroupSequenceProvider instead.Defines several
MultiFileSizeIf constraints on the same element.Deprecated.
Use a
GroupSequenceProvider instead.Constraint annotation validator for
MultiFileSize.A
Control for editing large string values that must conform to a ILargeStringValueDescriptor.A
Control for editing string values that must conform to a IStringValueDescriptor.MultipartFormDataInput
A reader for multipart/form-data requests that checks uploads for invalid/illegal content.
Deprecated.
use
MultipartMailData insteadText email data with attached Files
A reader for 'multipart/*' requests that checks uploads for invalid/illegal content.
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 preserves their mulitpart parts,
meaning the parts can be accessed multiple times during the entire request scope.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).Converts between a flat map
Map<String, V> with compound keys and a multivalued map Map<String,
List<V>>.Deprecated.
use
EncryptedVorgangsDataSQLBuilder insteadSpecial points on BPMN elements with a name.
Comparator-Implementierung für den Vergleich von
INamedUiElement-Instanzen.Matches on name (ignores group) property of Keys.
Klasse zum Sortieren von Plugins anhand des
INameProviding.getName()Deprecated.
since 8.0.0
Model class for defining a new keystore.
Represents a type of newline.
A processor for a specific type of newline.
Utility class for
Newline.View model for new messages.
Exception for missing credentials on a user profile.
An attribute list for nodes.
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.Represents a graph dot node ID.
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.
Used by a node to indicate that the node completed abruptly by issuing a return statement.
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.A graph dot element that represents a node statement.
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.Used by a
node to indicate that the node completed abruptly by issuing a control transfer
statement.A simple builder for configuring a
NodeTransferredControlException.POJO implementation of
INodeWithName.Annotation for marking fields to be not encrypted during JSON path serialization by
JsonPathMapConverter.Exception thrown when a pasword could not be generated.
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.Deprecated.
Use a
GroupSequenceProvider instead.Defines several
NonEmptySingleAttachmentIf constraints on the same element.Deprecated.
Use a
GroupSequenceProvider instead.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.Deprecated.
Use a
GroupSequenceProvider instead.Defines several
NonEmptySingleFileIf constraints on the same element.Deprecated.
Use a
GroupSequenceProvider instead.Constraint annotation validator for
SingleFile.POJO implementation of
INormalCompletionResult.A simple builder for an
NormalCompletionResultConstraint validation annotation that may be applied to
Strings.Defines several
NotEmptyHtmlTextContent constraints on the same element.Validator implementation for the
NotEmptyHtmlTextContent constraint.Constraint validation that may be applied to types that implements
ILocalizationViewModel.Defines several
NotEmptyLocalization constraints on the same element.Constraint validation that may be applied to types that implements
ILocalizationViewModelEntry.Defines several
NotEmptyLocalizationEntry constraints on the same element.Validator implementation for the
NotEmptyLocalizationEntry constraint, see their for more details.Validator implementation for the
NotEmptyLocalization constraint, see their for more details.When a resource or page could not be found.
Defines the assignee of a notification subscription, acting as an ID.
The type of assignee.
Bean that stores all faces messages that should be redisplayed in the notification history to the top right.
Represents a notification event with a payload of type `TPayload`.
Maker interface representing the payload of a notification event.
Types of notification events.
Service interface for managing notification subscriptions.
Localizer for the fc-notifications module.
Model class representing a notification subscription for a specific event type.
Service interface for managing notification subscriptions.
Defines a target for notifications, specifying the channel through which notifications should be sent.
Factory class for creating instances of
NotificationTarget.Model class representing a user interacting with the notification module.
Static methods for accessing the Noto Sans Regular layout font data.
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 nullable UUIDs.Custom
UserType for non-nullable UUIDs.Model class for the options used by our client-side $.xutil.numberFormat wrapper.
A simple builder for
NumberFormatOptions.Whether to pad decimals with zeroes, up to the number of decimal places.
Separator to use to separate the integer part of the number from the fractional part.
How to group digits in the integer part of the number.
Separator to use between digit groups.
Defines the behavior of the input field when it is empty, i.e. no number is present.
Defines how to treat leading zeroes, e.g.
The mode to use when rounding numbers.
Where to place the signum sign that indicates whether a number is positive or negative.
Where to place the unit sign, if any.
Thrown by the
NumberFormatParser when the input string could not be parsed, usually because it is not a valid
numeric string.Parses a formatted numeric string, according to the formatting rules from an
NumberFormatOptions instance.Deprecated.
Depending on the use case the appropriate profile creator should be used, e.g.
Deprecated.
Use
OAuth2AuthenticatorProperties instead.Model class for accessing the properties of an authenticator of type
EAuthClientType.GENERIC_OAUTH2 in a
structured manner.Helper class for OAuth2 related operations.
A scanner for visiting each instance field of an object via reflection.
A reference to an object (a concrete instance of a certain type of objects), consisting of the type of the objects
and the unique identifier of the object within that type.
POJO implementation of
IObjectReferenceDescriptor.Aspose based
IPdfConverter implementation for spreadsheet sources.Aspose based
IPdfConverter implementation for MS-Powerpoint and Open-/LibreOffice presentations.Aspose based
IPdfConverter implementation for MS-Word and Open-/LibreOffice text documents.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.
Base class for emulating a sum type (also known as a discriminated union) of N elements.
Base class for emulating a sum type (also known as a discriminated union) of N elements.
Base class for emulating a sum type (also known as a discriminated union) of N elements.
Base class for emulating a sum type (also known as a discriminated union) of N elements.
Base class for emulating a sum type (also known as a discriminated union) of N elements.
Base class for emulating a sum type (also known as a discriminated union) of N elements.
Base class for emulating algebraic sum types (also known as a discriminated union) of N elements.
Emulates a sum type consisting of 2 cases.
Emulates a sum type consisting of 2 cases.
Emulates a sum type consisting of 2 cases.
Emulates a sum type consisting of 2 cases.
Emulates a sum type consisting of 2 cases.
Emulates a sum type consisting of 2 cases.
Emulates a sum type consisting of 2 cases.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
Emulates a sum type consisting of 1 cases.
Emulates a sum type consisting of 1 cases.
Emulates a sum type consisting of 1 cases.
Emulates a sum type consisting of 1 cases.
Emulates a sum type consisting of 1 cases.
Emulates a sum type consisting of 1 cases.
Emulates a sum type consisting of 1 case.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
Emulates a sum type consisting of 0 cases.
Emulates a sum type consisting of 0 cases.
Emulates a sum type consisting of 0 cases.
Emulates a sum type consisting of 0 cases.
Emulates a sum type consisting of 0 cases.
Emulates a sum type consisting of 0 cases.
Emulates a sum type consisting of 0 cases.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
Emulates a sum type consisting of 3 cases.
Emulates a sum type consisting of 3 cases.
Emulates a sum type consisting of 3 cases.
Emulates a sum type consisting of 3 cases.
Emulates a sum type consisting of 3 cases.
Emulates a sum type consisting of 3 cases.
Emulates a sum type consisting of 3 cases.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
Emulates a sum type consisting of 4 cases.
Emulates a sum type consisting of 4 cases.
Emulates a sum type consisting of 4 cases.
Emulates a sum type consisting of 4 cases.
Emulates a sum type consisting of 4 cases.
Emulates a sum type consisting of 4 cases.
Emulates a sum type consisting of 4 cases.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
Emulates a sum type consisting of 5 cases.
Emulates a sum type consisting of 5 cases.
Emulates a sum type consisting of 5 cases.
Emulates a sum type consisting of 5 cases.
Emulates a sum type consisting of 5 cases.
Emulates a sum type consisting of 5 cases.
Emulates a sum type consisting of 5 cases.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
A matcher object that contains a handler for each case and can be used to reduce a sum type to a single value.
An unmodifiable list that extends another list and includes an additional item at the start.
An unmodifiable list that extends another list and includes an additional item at the start and at the end.
Used by methods from
IBpmnElementStore such as error(code, onMissing) to determine what to do when a raisable to retrieve is missing.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.
Identify the class or method as being filtered by
RestApiSecurityFilter.Utility class for working with
pac4j.Model representing the result for a paged query.
Helper for handling the various page formats used by the PDF converter implementations.
Wraps 'Apache POI' (or to be more precise 'open xml word processing') page format settings.
Wraps numeric page format constants used by Aspose, see e.g.
A 'record' that wraps width and height of a rectangle as integer values.
DTO for a page query.
A product type (also known as a tuple) of 2 elements.
A product type (also known as a tuple) of 2 elements.
A product type (also known as a tuple) of 2 elements.
A product type (also known as a tuple) of 2 elements.
A product type (also known as a tuple) of 2 elements.
A product type (also known as a tuple) of 2 elements.
View model for layout settings related to
parallel gateways in BPMN diagrams.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
Provider for all parent nodes that support a certain
control
transfer type.Represents a parsed field name from a submitted form.
Must be registered for a
PreRenderViewEvent.View model for layout settings related to
participants in BPMN diagrams.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.PASSWORD and
EAuthClientType.PASSWORD_GENERATOR_ACTIONCredentials consisting of a single password.
Deprecated.
Use
PasswordCredentials instead.Extractor for retrieving an password from an request
Deprecated.
USe
PasswordCredentialsExtractor instead.Interface for generating runtime passwords.
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.
Utility class to handle password related tasks.
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.Aspose based
IPdfConverter implementation for PDF documents.RuntimeException to be thrown in case of conversion problems.
Optional conversion parameters, see the particular converter implementations for supported values.
Some parameter names.
PDF conversion facade.
Deprecated.
use
PDFFillerHelper class to flatten a PDF document.
Utility for processing the a PDF document as a form.
Extracts images from a PDF document.
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.
Model for a file that was uploaded to the server and stored in a bean, but not yet written to the database.
Pending upload request view model class.
Generates the roles and permissions for the profile.
Utility class for persistence-related operations, such as extracting the DBMS type from a JDBC URL.
Deprecated.
Checks if the input of the form element is empty.
Replace a substring with another string.
The API for making structured REST API calls to the "PingApi" endpoint.
Service providing base functionality of the REST API
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.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.
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.
IPdfConverter implementation for plaintext sources.Plugin-Action-Servlet
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).Helper class for handling unmanaged beans used by user interfaces provided by a plugin, e.g. a dashboard plugin or a
workflow action plugin:
A simple POJO that holds the extracted information of a bean.
Options for the
PluginBeanHelper.Simple builder class for a
PluginBeanOptions.A mail security certificate provider that uses plugins to find certificates for email addresses.
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.
The ID of a particular
plugin extension point contained in a plugin JAR, consisting of the plugin's
ID and the name of the IFCPlugin.This class is for storing data of a plugin file with a file key.
Simple POJO implementation of
IPluginFormPreRespondParams.Default implementation of
IPluginFormPropertiesExtensionRetVal.Builder for
PluginFormPropertiesExtensionRetVal.Default POJO implementation of
IPluginFormResourceGetDataParamsDefault POJO implementation of
IPluginFormResourcesParamsDefault 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.
The ID of a plugin, consisting of the plugin JAR's key and an optional file 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.
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.Default implementation of
IPluginServletActionParams with a builder.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.
Deprecated.
Use
PluginAuthenticatorProperties instead.Helper functions for working with ZIPs containing a list of formcycle plugins.
An n-dimensional point with coordinates of type
Number.A graphviz 2D or 3D point. 3D is valid only when the attribute
dim is set to 3.A 2-dimensional point with coordinates of type
Number.A 2-dimensional point with coordinates of type
Number.A 2-dimensional point with coordinates of type
Number.A 2D point with double precision coordinates.
Adapter for treating arbitrary objects as a
Point2DDouble.A point with coordinates of type
Number that has a dimension of at least 2.Enumeration with the possible relationships between a range and a point.
POJO implementation of
IWorkflowValidationEnvironmentData.Base POJO implementation of
ILocalizationViewModel with implementations for most methods, but still a generic
type for the entry type.POJO implementation of
IWorkflowValidationEnvironmentData.Deprecated.
DO NOT USE.
A 2-dimensional polygon defined by a list of points.
Represents a graph dot port.
The model for the portal header which holds the data from the portal localizations.
Deprecated.
This class is used to store the custom properties of the user portal for the display in a datatable.
Wraps a
ServletContextListener from a plugin.*
Represents an item that has a position.
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.
Base exception for exceptions that can occur when posting a form record message.
Exception indicating that the chat is not open (and that the chat must be open to post a message).
Exception indicating that no chat was found.
Exception indicating that the given form record does not exist.
Exception indicating that no user was provided to post the message (and that a user is required to for a message
to be posted).
Exception indicating that no existing chat was given.
Exception indicating that no form record was given.
Runtime exception that wraps a checked exception that occurred when posting a form record message.
Generic exception indicating that the post message request could not be fulfilled due to an unknown or unhandled
error.
Exception indicating that the sender of the message is not a member of the chat and cannot post a message to the
chat.
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.
Controller which implicitly applies and stores user-specific 'sort' settings related to the 'extended processes'
views of the inbox.
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.Similar to
ProcessMessagesBean, but for downloading files.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.
The API for making structured REST API calls to the "ProfileApi" endpoint.
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
Basic data about a client.
Builder for a
ProjectBaseData.Payload for project change events.
Deprecated.
Use
ProjectCreationBean insteadContains the counter data for the statistics of a project.
Central 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.
Deprecated.
Only used by the old workflow.
Deprecated.
For creating duplicates of
ProjektsDeprecated.
This event handler has been deprecated in version 8.0.0 because
LoginEvent are no longer fired.Result of the project export analysis, containing identified project dependencies and any errors encountered during
the analysis.
Model representing an entity which is a dependency of a project for export purposes.
Enumeration of possible project entities for referencing purposes.
Deprecated.
Use
ProjectExportService insteadSpecification for exporting a project, including the project ID and any additional dependencies to include.
Entity model for the metadata of a file from a project
Entity model for the data of a file from a project
Bean for editing the groups of a project
Helper class for projects.
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.
Implementation of the localizations for
Projekt entities.Helper class for (safely) creating/updating formcycle
projects.Bean for working with project message extensions.
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.Entity model for project portal config.
API for reading and writing
ProjectPortalConfig entities.Implementation of the
IProjectPortalConfigDao for reading and writing ProjectPortalConfig entities.Entity for storing project specific portal data.
API class for reading and writing
ProjectPortalData entities.DAO for reading and writing
ProjectPortalData entities.Handler implementation for reading and writing
ProjectPortalData entities.Entity model for end user tags. user portals tags are manged portal-wide and may be assigned to forms.
API class for reading and writing
ProjectPortalTag entities.Implementation of the
IProjectPortalTagDao for reading and writing ProjectPortalTag entities.DTO for project end user tags.
Handler implementation for
ProjectPortalTag entities.Implementation of the localizations for
ProjectPortalTag entities.DTO for a project end user tag filter.
DTO for a project end user tag sorting.
View model for the configuration UI of a project's tag.
Converter for
ProjectPortalTagViewModel.Bulk updater for form records based on there project.
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
DTO for a project filter.
Executor for project queries.
Query helper for projects.
DTO for a project sorting.
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.
Model class representing a user that interacts with the project module.
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
ProjectExportService 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.
Factory for creating instances of
FcPromptTypeException and its subclasses.Provides common implementations of
IPromptBinaryData.View model for a single file, intended to be used as part of the
deserialized prompt connection
configuration or deserialized prompt
query configuration.Annotation for model classes that represent the abstract base class of a discriminated union, intended for use with
the
JsonConfig mixin for prompt service
handlers.Annotation for a model class that represents a subclass of a discriminated union, intended for use with the
JsonConfig mixin for prompt service
handlers.Annotation for the discriminator field of a model class that represents the abstract base class of a discriminated
union, intended for use with the
JsonConfig mixin for
prompt service handlers.Optional annotation for customizing instance fields when serializing and deserializing prompt configuration
instances.
Internal service interface for marshalling and unmarshalling prompt configuration objects to and from JSON.
Controller bean for the UI that lets the user manage prompt connections.
Provider for the prompt connections available in the current client during workflow editing and validation.
Represents a prompt connection, i.e. the configuration needed to establish a connection to a prompt service.
Builder for prompt connection data instances.
Represents a prompt connection option that the user can select.
View model for editing a prompt connection in the GUI.
Base class for all exceptions that occur during the execution of a prompt query.
Base builder class for prompt execution exceptions.
The types of prompt export files.
Generic view model for the
<p:selectOneMenu /> components, representing one selectable option.A configuration for a set of files, used by the configuration of a prompt connection or query.
A set of files for dynamic file input parameters of a prompt query.
Models a file type, which can either be defined by its file extension (e.g. ".txt") or by its kind (e.g.
A
PromptFileType that identifies a file by its extension, e.g. ".txt" or ".png".A
PromptFileType that identifies a file by its kind, e.g.Enumeration of file kinds, which can be used to categorize files by their content type rather than by their file
extension.
Factory for common alpha channel converters.
Internal interface with the implementation of the factory methods from
PromptImageFormatConverters, i.e. the
factory implementation for common image format converters.Factory for common image format converters.
Factory for common
IPromptImageGeometryConverter implementations.Represents the target geometry of an image.
Builder for
PromptImageGeometryData.Faces validator for string values that checks whether the string represents a valid JSON schema, according to the
JSON Schema specification Draft 2020/12.
Faces validator for string values that checks whether the string represents a valid JSON.
Helper for accessing localized strings.
Helper for accessing localized strings.
The identifier of a prompt object, i.e. a prompt connection or a prompt query.
Helper for the prompt query workflow action with logic required for the UI.
View model for the prompt query workflow action configuration UI.
Provider for the prompt queries available in the current client during workflow editing and validation.
Holds the data of a prompt query export file along with its analysis result.
Helper class with logic for executing prompt queries on the prompt configuration UI, allowing users to test their
query beforehand.
Represents the result of a prompt query test execution, as started by the user in the backend query configuration UI.
View model for testing a prompt query.
The scope to which a prompt object can be assigned, consisting of the kind of scope and its ID within that kind.
Enumeration with the possible scoped a prompt object can be assigned to.
Defines how to resolve prompt scopes.
Registrator for search expressions related to prompt UIs (for PrimeFaces's search expression framework).
Exception thrown when there is an error during the serialization or deserialization of prompt configurations.
Mixin interface for
IPromptServiceHandler implementations that provides JSON marshalling for the prompt
connection and query configuration.An input file for a prompt query uploaded by the user; or an output file (returned by a prompt query), used by
PromptQueryTestViewModel when testing prompt queries in the prompt query configuration UI.View model for a file control in the prompt query test editor.
A list of output files (returned by a prompt query), used by
PromptQueryTestViewModel when testing prompt in
the prompt query configuration UI.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.
Metadata for a builtin localizable property.
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.
Model class for public resource references.
Reference to the chat the message is associated with.
Reference to the message that the upload request is associated with.
A reference to the client the form record is associated with.
The client the form belongs to.
The client the form belongs to.
A reference to the form the form record is associated with.
The form the file is attached to.
The form the file is attached to.
PublicResourceReferenceUserPortal
PublicResourceReferenceUserProfile
A reference to the form record the chat is associated with.
Class providing constants for the public REST API.
Link relation keys for the authenticator.
Link relation keys for the form record.
Link relation keys for the form record chat.
Helper class to generate URIs for the public generic REST API.
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.
A quantity with a numerical value with a
MeasurementUnit.A
Quantity that uses a BigDecimal as its value.A
Quantity that uses a double as its value.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
AutoCloseable that does not throw any checked exceptions.A range map to which ranges can be added.
Utilities with additional methods on
Ranges.Exception thrown when executing a prompt query against a prompt service whose rate limit has been exceeded.
Builder for a
RateLimitExceededException.Deprecated.
Factory for GSON type readers
Default POJO implementation of
IReadObjectReferencesParams.Default POJO implementation of
IReadPlaceholdersParams.Component class for the
<xp:readTimeout /> component.Implementation of
IRecipientEncryptionResult.Base class of a
Control for a record entry container, either the start or end of a record entry.A
Control that represents the end of a record entry container.A
Control that represents the start of a record entry container.A wrapper that delegates to another
IRecordValueDescriptor.A 2-dimensional rectangle with double precision.
An n-dimensional rectangle with coordinates of type
Number.A one-dimensional rectangular shape, with only a width.
A rectangular shape of at least dimension 1.
A 2-dimensional rectangular shape.
A two-dimensional rectangular shape, with a width and a height, where both dimensions are of type
double.A rectangular shape of at least dimension 2.
A two-dimensional rectangular shape, with a width and a height, where both dimensions are of type
long.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.RefreshRequest
Listener for UserRefreshToken deletion.
Data transfer object for the user data that is stored in a refresh token.
Parameters that can be passed as the second parameter to the client side JavaScript method
Flowchart.registerBaseCondition.Parameters that can be passed as the second parameter to the client side JavaScript method
Flowchart.registerBaseDoUntilLoop.Parameters that can be passed as the second parameter to the client side JavaScript method
Flowchart.registerBaseWhileLoop.Reinitialisierung der MySQL-Projekttabellen aufgrund eines Encodingproblems
POJO model for the state added push event.
CDI qualifier for the remote address.
Helper methods for
<p:remoteCommand>, such as reading parameters and returning a value.A utility class for downloading data from a remote datasource via HTTP GET requests.
POJO for the response of an HTTP GET request.
Interface for executing HTTP GET requests.
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_TYPE>_WORKFLOW_TRIGGER_<FORM_RECORD_UUID> to
<WORKFLOW_TRIGGER_TYPE>_WORKFLOW_TRIGGER_<FORM_RECORD_ID>_pid#<PROJECT_ID>_cid#<CLIENT_ID> .
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.
Base class for the body of endpoints that allow multiple different request body types.
Base class for the body of endpoints that allow multiple different request body types.
Base class for the body of endpoints that allow multiple different request body types.
Base class for the body of endpoints that allow multiple different request body types.
Base class for the body of endpoints that allow multiple different request body types.
Base class for the body of endpoints that allow multiple different request body types.
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.Exception thrown when executing a prompt query and the prompt service refuses to process the request, e.g. because
violates its usage policies or contains inappropriate content.
Builder for a
RequestRefusedException.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.Default JWT authenticator that requires a specific
issuer.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.Default POJO implementation of
IResolvedFileSourceWorkflowTrigger.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.
Bean to read resource bundles.
Helper for creating the aggregate resource bundle used by the workflow designer.
Bean-Klasse zum Anzeigen von Resourcen.
Provides the default validation groups for
ResourceItem.A choice provider for the workflow that finds the available resource items from the current
bean validation context obtained via CDI.Factory for
IResourceLinkMapper.Factory for common
IResourceMatchers.Helper methods for refactoring content in resource files.
Factory for creating
resource store managers.Utility class for handling entity resources
Exception thrown when executing a prompt query and the system refused to accept the response from the prompt service,
e.g. because violates the system's policies or contains unsafe content such as malware.
Builder for a
ResponseRefusedException.Info about a response with the return type and the sum type.
Info about a response with the return type and the sum type.
Info about a response with the return type and the sum type.
Info about a response with the return type and the sum type.
Info about a response with the return type and the sum type.
Info about a response with the return type and the sum type.
Annotation for injecting resources in a REST API context.
Filter that checks if the public REST API is available.
Servlet context listener for executing common initialization and shutdown tasks for the public REST API.
Represents a CORS origin for the REST API.
Modified version of
SecurityFilter, that dynamically generates the String for the client names based on a CDI
injected client (Mandant) scope.Factory for creating Pac4j
Clients.Class providing constants for the REST API.
Constants for link relations.
Constants for media types.
Constants for parameters.
Default values for parameters.
Limits for parameters.
Constants for paths.
Helper class for creating ETags
Helper class for working with requests.
Helper class for REST services.
Helper class for working with URIs of the REST API.
Builder for creating
rewrite URI resolvers.A
DateFormat implementation that formats dates according to RFC3339.A
DateFormat implementation that formats dates according to RFC3339.A
DateFormat implementation that formats dates according to RFC3339.A
DateFormat implementation that formats dates according to RFC3339.A
DateFormat implementation that formats dates according to RFC3339.A
DateFormat implementation that formats dates according to RFC3339.Represents an RGBA (red, green, blue, alpha) quadruplet.
JPA converter for colors represented as
RgbaQuadruplet.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.4Update to set the access properties of all roles to the default values.
Update to set the access properties of all roles to the default values.
Update to set the access properties of all roles to the default values.
Update to set the access properties of all roles to the default values.
Update to set the access properties of all roles to the default values.
Deprecated.
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
XRollingFileAppenderBase class of a
Control for a root value added to the form.A
Control for the end of a root value added to the form.POJO model for a root option that can be added to a form of value descriptors.
Service providing base functionality of the REST API
A
Control for the start of a root value added to the form.Factory for
IRoutingContext.Interface that encapsulates all certificate and key-related operations available within the XIMA formcycle
certificate module.
Service for analyzing cryptographic files and data on the master server.
Common interface for the RPC handler for certificates.
Service interface for managing cryptographic settings related to key algorithms in the formcycle certificate module.
Interface representing a resolver for the password used to encrypt RPC communication.
Common interface for RPC (Remote Procedure Call) handlers.
Common interface for RPC (Remote Procedure Call) handler producers.
Common interface for RPC (Remote Procedure Call) handler providers.
Implementation of the injectable
RpcHandlerProvider.Interface that defines the operations for managing keystores within the XIMA formcycle certificate module.
Utility class for handling encrypted key stores in the context of RPC invocations.
Service interface forwarding RPC calls related to mail operations.
Service interface for forwarding RPC calls related to notification management.
Default password generator that can be used to generate runtime passwords.
Implementation 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.Model class for accessing the properties of an authenticator of type
EAuthClientType.GENERIC_OPENIDCONNECT in
a structured manner.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
Event indicating that the scheduler is going into standby mode.
Interface for providing access to the Scheduler instance.
Event indicating that the scheduler is shutting down.
Event indicating that the scheduler has started up and is ready to execute tasks.
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).
This
Renderer handles the rendering of script references.Registrator for additional generic search expressions (for PrimeFaces's search expression framework).
Simple POJO class for a search term with string key and a string value.
JSF Converter for secure password handling.
Factory for creating instances of
SecureRandom.Factory for securely pre-configured factories for processing XML
Provides a
ApiBundle for the public security REST API.Provides the default
ITokenEndpoint implementation using the public security REST API.Servlet context listener for executing common security initialization and shutdown tasks.
Service providing base functionality of the REST API
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.
Provides the packages of the generic REST services.
Helper for dealing with request in formcycle.
Helper for working with
IWebEndpoints.Model for selecting a server.
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.This is a helper bean for selecting a key store in the GUI.
Default POJO implementation of
ISendMailReport.Builder for
form record message objects.Exception thrown when sending a message fails.
Executor for sending form record messages.
Default POJO implementation of
ISendMessageAttachmentDataBuilder for
ISendMessagePluginResponse.Factory for creating
ISendMessageRecipient instances.Builder for
ISendMessageRequest.Builder for
ISendMessageResponse.Builder for
ISendMessageUploadRequestDataDefault POJO implementation of ISentMailData.
View model for layout settings related to
sequence flows in BPMN diagrams.Annotation to indicate the order of an
IOrderableExtends the serenity menu to provide support for icons from different icon fonts.
A serialized primitive JSON value, together with its type.
Represents a serialized prompt configuration, with plain text and binary values.
A builder for creating instances of
SerializedPromptConfig.Common interface for server configuration details.
Event representing changes to the configuration of a server.
Factory class for creating instances of
IServerConfig.Resolver that requires an active
server configuration feature.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.
Exception thrown when executing a prompt query against a prompt service that is currently unavailable.
Builder for a
ServiceUnavailableException.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.
Producer for servlet-related objects.
Default POJO implementation of
IServletResponse.Helper class for working with sessions.
Deprecated.
Placeholder provider for session attachment placeholders.
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.BPMN modeler for nodes of type set form record password.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.
Utility class for Simon.
A default
IJsonPrimitiveConverter that converts between JSON primitives and strings.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.Models a single conditions with an operator and one or two operands.
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.Component class for the
<xp:singleFile /> component.View model for a single file control in the prompt query action editor.
A
Control for editing large string values that must conform to a ILargeStringValueDescriptor.A
Control for editing string values that must conform to a IStringValueDescriptor.A simple wrapper around a
Store to store a single value.Enumeration for a single input or output file that describes whether the file is required, optional, or never
allowed.
Remove validators during prevalidate and restore them during postvalidate.
Improved version of OmniFaces
SkipValidators tag handler with the following differences:
Works with components inside a DynaFormModel.Parameters for testing a socket connection to a specified host and port.
Sort direction for sorting.
Enum for sorting.
Simple event wrapping information about sort settings, ment to be triggered and processed in case of changes made to
the field to sort by and/or the sort direction.
Compares two strings and ignores upper / lower case.
Base implementation of
ILocalizationViewModel that allows for a custom source of localization entries, but
POJO implementation for the remaining view related data.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.Types of common newlines.
Standard attribute for value and file descriptor attributes,
IValueDescriptor.getAttributes() and
IFileListDescriptor.getAttributes().Standard values for message content attributes, such as
StandardValueDescriptorAttributes.VALUE_DESCRIPTOR_ATTR_LABEL_CONTENT.Standard values for message type attributes, such as
StandardValueDescriptorAttributes.VALUE_DESCRIPTOR_ATTR_LABEL_TYPE.Standard values for the
StandardValueDescriptorAttributes.VALUE_DESCRIPTOR_ATTR_UI_TYPE attribute.Special chat entry to indicate the start of a chat.
View model for layout settings related to various
start events in BPMN diagrams.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.
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.
The state history of the form record.
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.
A generic implementation of
IFormTheme with a builder.Builder for a
form theme.Metadata of a file in a form theme.
A builder for configuring the metadata of a file in a form theme.
Loader for the contents of a specific file in a form theme.
Provider for the inheritance mode of a file in a form theme.
Provider for the flag that indicates whether to offer CSS classes as suggestions, for a file in a form theme.
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.
A base class for
Controls used to edit string values that must conform to a IValueDescriptor.String data that can be added to a HTTP request.
Utility Class containing helper methods for working with a data grid model of type
StringSimple index-based String list serialisation, does not support
null values.Helper methods for working with strings.
Helper methods for working with strings.
Helper methods for working with strings.
Helper methods for working with strings.
Helper methods for working with strings.
Helper methods for working with strings.
Similar to Guava's Striped, but with a few additions:
Serializable, AutoCloseable support, and a
method to lock all stripes.Represents a styled BPMN label, including the label text and its style definition.
A list of doubles.
An attribute list for sub graphs.
Deprecated.
This is not used anymore and can be removed.
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.
View model for layout settings related to
sub processes in BPMN diagrams.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
SupportInquiryDataApache Batik based
IPdfConverter implementation for SVG images.Entity 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.Implementation of the localizations for
SystemAuthenticator entities.Entity for storing informations about the already performed system-updates
Builder for system dashboard panel entries.
IFormTheme implementation for system form themes, i.e. built-in form themes provided by the formcycle app.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.Interface for providing health status of the system persistence layer.
Interface for managing the persistence layer of the system database.
Event that is fired when the persistence system is shutting down.
Event that is fired when the persistence system has started.
Placeholder provider for system placeholders.
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
View model POJO for users to define a system prompt that is sent to the prompt provider.
Entity for system-wide properties
Event indicating that the system should shut down.
Event indicating that the system should start up.
Deprecated, for removal: This API element is subject to removal in a future version.
use
FormcycleUpdate insteadEvent that is fired when all system updates have been executed.
Represents the formcycle version of a
ISystemUpdate.Meta 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 tagify tag that can be used e.g. for a dropdown with available options.
A pair of a
FacesMessage with its client ID.Wrapper to treat a
IRemoteEventExecutionResult as a
IWorkflowResponse.View model for layout settings related to
tasks in BPMN diagrams.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.Event for the
Flowchart component, when a visualization of the flow graph of a task was requested (by
clicking on the visualize button).POJO implementation of
ITaskWithName.An
AutoCloseable wrapper for a File that deletes that file when closed.An
AutoCloseable wrapper for a file that deletes that file when closed.Factory for temporary files creators.
Model representing
Textbaustein dataParameters for the create template remote command, see
FormTemplateHelper and
FormDesignerTemplateBean.createFormTemplate() / FormDesignerTemplateBean.updateFormTemplate().Deprecated.
Deprecated.
Controller bean for managing template keywords.
Provides
template placeholders.Bean für die aktuelle Session und deren Informationen
Model that holds the data for the bulk delete confirmation dialog, when the user selects multiple templates and
wants to delete or reset them.
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.Basic data about a tenant.
Manager for dealing with test clients.
Helper with static utility functions for writing tests.
POJO class with details on the formcycle mock system environment created for tests.
View model for layout settings related to
text annotations in BPMN diagrams.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.
A
CrudMapAdapter for a map from file keys to the file's text content, backed by a ICommonFileSystem.Builder for a
TextFileSystemViewCrudMapAdapter.Model containing basic mail properties
Represents a single run of text to be shaped.
View model for the text settings in a BPMN diagram.
Main entry point for accessing
ITextShaper features.Event for when an entity was modified, either when it was created, updated, or deleted.
A
UploadedFile with data from a text string.Main entry point for
ITextWrapper features.Resource for plugin backend themes
A new column was added to the FormVersion entity:
FormVersion.getTheme().The
MeasurementUnit for a length or distance.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.Models the
expression of a time event in BPMN.Common units of time.
The TLS scope.
The type of TLS scope.
Interface for SSL/TLS services.
Configuration for the token generation.
Exception that is thrown when a token cannot be created.
Technical exception indicating that a token has expired!
Bean for handling TOS (terms of service) agreement of users.
Deprecated.
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.A
ITreeAccessor for ValueDescriptorNode.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.Deprecated.
Deprecated.
Use
TreeAccessorXItem instead.A
ITreeAccessor for XItem that accesses the children of an item.An iterable that iterates over a tree-like graph in pre-order, starting at a given node.
Flags for iterating over trees, see
TreeIteration.Deprecated.
Use the new workflow engine (
IWorkflowEventRunner).Deprecated.
Use
TreeParentAccessorXItem instead.A
tree parent accessor for XItem.Deprecated.
Use
TreeParentIterable instead.Deprecated.
Use
TreeIterationDeprecated.
Use
TreeReversePostOrderIterable instead.An event that is fired when the currently selected tree node (workflow) is changed.
Deprecated.
Use
TreeVisit instead.Indicates how to proceed with a tree visit, see
TreeVisit and TreeVisit.ITreeVisitor.Visitor for a tree data structure.
A convenient
TreeVisit.ITreeVisitor with a path parameter for the methods. useful if you do not
need it.Represents a fragment or part of the path of a node in a tree data structure.
Parameters for
TreeVisit.A builder for configuring the parameters for
TreeVisit.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.
Provider for the that makes available all nodes in the entire workflow process that are of a given
type.POJO implementation of
ITriggerWithName.Model class representing the result of a trust validation in a TLS context.
Represents a byte array with a content type (MIME type).
Represents a
File with a content type (MIME type).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
Exception thrown when executing a prompt query against a prompt service and the service rejected the request due to
unauthorized access.
Builder for a
UnauthorizedPromptRequestException.A undirected edge statement.
An undirected graph.
A sub graph statement with undirected edges.
A sub graph expression with undirected edges.
When an answer was received from the REST API, but the status code did not match
any known status code.
When an answer was received from the REST API, but the status code did not match
any known status code.
When an answer was received from the REST API, but the status code did not match
any known status code.
When an answer was received from the REST API, but the status code did not match
any known status code.
When an answer was received from the REST API, but the status code did not match
any known status code.
When an answer was received from the REST API, but the status code did not match
any known status code.
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
ClientCountersValidator that ensures the name of a
ClientFormTheme is unique amongst all other themes of the same
client.A
AUniqueNameValidator for the Mandant.getName()A
AUniqueNameValidator for the FrontendServer.getName()Custom-Validator für die Überprüfung der Eindeutigkeit eines Logger-Namens
Helper class for generating unique names.
Deprecated.
Use
UniqueNameGenerationHelper instead.Options for generating unique names.
Deprecated.
Use
UniqueNameGenerationHelper.NameGenerationOptions instead.Validator for the uniqueness of a prompt connection name within its scope.
Validator for the uniqueness of a prompt query name within its scope.
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
A Validator for ensuring that the alias of a
UserPortal is unique.A Validator for ensuring that the name of a
UserPortal is unique.Validator for checking if a given email address is existing as an already verified address.
A
AUniqueNameValidator for the WorkflowState.getName()The
Unit class represents the unit datatype with only one member (one possible value).GSON adapter that serializes
Date as UNIX timestamps in milliseconds (since 1970/01/01).Exception that is thrown when a token is unknown.
POJO for an extracted flowchart snapshot.
Represents a JAR file that was unpacked to the file system.
This exception is thrown when malware or content type checks fail.
Bean to keep track of unsaved changes in the GUI.
When an answer was received from the REST API and the status code did match
a known status code, but that status code was not a success status code 2xx.
When an answer was received from the REST API and the status code did match
a known status code, but that status code was not a success status code 2xx.
When an answer was received from the REST API and the status code did match
a known status code, but that status code was not a success status code 2xx.
When an answer was received from the REST API and the status code did match
a known status code, but that status code was not a success status code 2xx.
When an answer was received from the REST API and the status code did match
a known status code, but that status code was not a success status code 2xx.
When an answer was received from the REST API and the status code did match
a known status code, but that status code was not a success status code 2xx.
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.
View model for an upload request element.
Meta data about an uploaded file.
Model for an upload form element.
Factory for creating upload elements.
Upload request view model class.
This model holds the data for the POST request to upload files for upload request
View model for an upload request element.
Deprecated.
This class was added during development, but never used.
Default implementation of the
IUploadVerificationBean interfaceFactory 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.
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.Backing bean for user certificate administration.
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.Basic data about a user.
A
IValueDescriptor for the data of a user.Deprecated.
since 8.0.0 Users within clients are defined as
DirectClientAuthorizations.Helper Bean for user discovery using lookup services of authenticators.
Service providing base functionality of the REST API
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.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.
UserHeader
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
Builder for the event data for running a specific trigger, specified by its ID.
E-Mail zur Benachrichtigung eines Benutzers über die Erstellung/Änderung seines Kontos.
Entity representing the temporary token that is needed in conjunction with the two-factor authentication code when
verifying a user via two-factor authentication.
Default implementation of the
IUserMfaTempTokenDao interface for reading and writingException thrown when a user's temporary MFA token has expired.
Exception thrown when the maximum number of temporary MFA tokens for a user is exceeded or if the maximum number of
verification attempts has been reached.
Exception thrown when a temporary MFA token is not found.
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
Placeholder provider for user placeholders.
Entity model for user portals.
High-level methods for interacting with the user portal API.
API for reading and writing
UserPortal entities.Entity model for authenticator configurations for
user portals.API for reading and writing
UserPortalAuthConfig entities.The default implementation of
IUserPortalAuthConfigDao that can be accessed via
DaoProvider.Handler implementation for reading and writing
UserPortalAuthConfig entities.Loads the authenticators of the requested portal.
REST service providing endpoints for user profiles.
Filter for checking the availability of a user portal.
Filter that checks if the User portal feature is available.
Provider for the errors of this filter.
List of user portals, keeping the selected and marked user portal in view, and methods for creating and deleting user
portals.
A bean to cache values for the current user portal.
Factory for creating Pac4j
Clients.Configuration of a single selected user portal via different tabs.
Bean for handling files in the user portal backend UI.
Produces the user portal configuration.
Connection pool for the user portal API.
Context listener for the user portal connection pool.
Constants for common request parameters.
Validator for the user portal and custom portal message keys.
This class is used to store the custom properties of the user portal for the display in a datatable.
Implementation of the
IUserPortalDao for reading and writing UserPortal entities.Deprecated, for removal: This API element is subject to removal in a future version.
Helper bean for working with dates in the user portal.
Service providing base functionality of the REST API
Model for the parameters of a dynamically streamed file, e.g. for
GraphicImage served by the user portal
backend UI.Exception handler for exceptions that occur within the context of a user portal.
Entity model for the metadata of a file from a user portal
Entity model for the data of a file from a user portal
Bean for accessing the binary data of file providing resources.
Factory for creating streamed content for form record attachments.
This class represents a file attached to a form record.
Model representing a page of
BaseUserPortalFileResources provided by the PUBLIC REST API.REST service providing endpoints for user profiles.
A temporary file stored on the file system.
Request bean for the form records
REST service providing endpoints for user portal form resources
Request bean for the form records
This bean is used to display growl messages.
Handler implementation for reading and writing
UserPortal entities.Extended JEE HTTP action adapter that adapts actions with location and content and redirects to default pages if no
content or location was given.
Context listener for initializing the user portal security context.
Factory for creating
IUserPortalInvocationContext instances.Bean that keeps the session alive, for use with the composite component
xi:keepSessionAlivePollSession-scoped manager for the current locale of the user portal.
Implementation of the localizations for
UserPortal entities.Entity for the login configuration of a
user portal.The bean for the multi-factor authentication (MFA) page of the user portal.
Exception thrown when multi-factor authentication (MFA) is required for a user portal authentication process.
When the HTTP websocket client is used, delays the rendering of the page until the websocket is connected.
Provides
user portal placeholders.Helper functions for creating
EndUserProjectConfigViewModel, used by the backend configuration UI.Properties model class of the
UserPortal entityFilter that checks if the User portal feature is available.
Page model representing a collection of user portals.
Model representing a page of
BaseUserPortalResources provided by the PUBLIC REST API.Authenticator interface for the user portal REST API.
Manages the REST client instances for interacting with the user portal REST API.
Provides the packages of the user portal REST services.
Redirect configuration provider for the user portal.
Handles URL routing for user portal pages.
The API for making structured REST API calls to the "UserPortalsApi" endpoint.
REST service providing endpoints for user profiles.
The bean for the sign-in page of the user portal.
Handler for unauthorized responses (401 HTTP status code) from the user portal REST API.
This class provides utility methods for the user portal.
Manages the request context for a portal page.
Helper functions for various UI related operations on user portals.
View model for editing a single
UserPortal.Utility class for user portal security.
The bean for the welcome page.
Servlet for handling the response of a workflow trigger.
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.Deprecated, for removal: This API element is subject to removal in a future version.
Bean for permanently deleting user profiles.
A
IValueDescriptor for the data of a user profile, consisting of a display name, email
addresses, etc.Entity representing files of a user profile
Entity containing the actual data of a user profile file entity
The files of the user profile.
Generates a
formcycle user profile if access to the backend is granted and
none exists.Handler implementation for reading and writing
UserProfile entities.Helper class for user profiles.
The API for making structured REST API calls to the "UserProfileImageApi" endpoint.
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.
REST service providing endpoints for user profiles.
Factory for creating
user profile tasks.DTO for a user reference.
Factory for creating
user reference resolvers.Factory class for creating instances of
IUserRefExtension.Provides the packages of the generic REST services.
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.API class for reading and writing
UserRefreshToken entities.Controller for user token operations.
Model representing a user that has been authenticated at some point.
FacesConverter for UUIDsDeprecated.
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.
Mixin for classes extending
UIComponent that implements processValidators(context) by first validating the component itself, then processing its children.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.Constraint validation annotation that may be applied to
Strings.Defines several
ValidHtml constraints on the same element.Validator implementation for the
ValidHtml constraint.Class for validating
Setting.Factory for creating
IValueAcceptanceCriteria instances.Builder for custom value acceptance criteria.
Utility class to create
IValueBuilderOptions instances.Beschreibung eines Wertes (Name, Typ und Wert).
Default implementation of the
IValueDescriptorFactory.The form built dynamically from value descriptors.
Backing bean for the
<xi:valueDescriptorForm /> component.Model for a value descriptor form, for use with the
<xi:valueDescriptorForm> component.A builder for creating a dynamic value descriptors model, which is used to display a dynamic UI form for editing a
value that conforms to a specific value descriptor.
Wrapper to treat
value descriptors as nodes in a tree structure.Node representing the list item value descriptor of a list value descriptor.
Node representing the map value descriptor of a map value descriptor.
Node representing a record member at a certain key in a record value descriptor.
Node representing the root of the value descriptor tree.
Node representing a tuple element at a certain index in a tuple value descriptor.
Implements
TreeVisit.ITreeVisitor for ValueDescriptorNode and adds specific methods for each subtype of value
descriptor node.View model for the workflow designer, used in the info panel of a node or trigger.
Operations on
value descriptors.Represents the parameters of form HTTP request as key-value pairs.
A
Control that references a value via a JSON path expression.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.
VerifyMfaCodeRequest
Groups all plugins with the same plugin key.
A target plugin that is to be updated.
Details regarding the versions of the formcycle application and its components.
View scoped bean allowing access to data of the current view.
Mapper for EntityType to ViewEntityType.
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.
Service to manage keystores in the GUI.
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.
After the view was restored, checks whether the corresponding
@ViewScoped bean instances still
exist and throws a ViewExpiredException if they do not.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.
Combines a
ICommonFileSystemVolume with a ICommonFileSystem.A form record (Vorgang) is a record of a
form submission.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.
Resolver that requires an active
web app
context feature.Servlet context listener for executing common initialization and shutdown tasks for all types of web applications
(MS, FS, FS-INBOX).
Performs actions that need to be executed after the Faces application has been constructed, such as initializing
portal plugin runtimes.
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.
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.
IPdfConverter implementation for WebP images.A weighted color, used in color lists for gradients etc.
WelcomePage
This class represents the model for the welcome page of the user portal.
Builder for configuring an instance of the welcome page model.
Deprecated.
DO NOT USE!
Represents a Weld environment that was started for tests.
The
INodeExecutionData published by the EWorkflowNodeType.FC_WHILE_LOOP.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.Controller bean for the BPMN editor of the flow graph.
Style definition for a BPMN label.
Default implementation of
IWorkflowBpmnLayoutSettings with a builder.Simple builder for a
WorkflowBpmnLayoutSettings instance.Represents a reference to an interface point in a BPMN diagram, where a sequence flow starts, ends, or passes
through.
A
WorkflowBpmnPointRef to the in port of a FlowNode.A
WorkflowBpmnPointRef to the out port of a FlowNode.A
WorkflowBpmnPointRef to a FlowNode.A
WorkflowBpmnPointRef to the in-port a IStructuredBpmnModelPartA
WorkflowBpmnPointRef to the out-port a IStructuredBpmnModelPartFactory for creating
WorkflowBpmnTextLayoutSettings instances.Internal mapper that applies custom logic to operands when evaluation conditions, used by the multiple condition node
and the switch node.
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.Deprecated.
Use the builder from the parameters given to the corresponding
workflow trigger method or
workflow node method.Simple builder for a
IWorkflowFileValue.Implementation of
IWorkflowFlowAnalysis that analyzes the execution of a workflow task or process.Controller Bean for visualizing the flow graph of a workflow task or processing chain as a graph diagram.
Model for the flow graph visualization component of the workflow designer.
Methods for initiating the workflow for a given form record.
Listener that registers the bean validation context implementation required by the workflow engine.
Helper for resolving localized messages for workflow elements.
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
Helper class for transforming data from a workflow response.
Deprecated.
Remove once the old workflow is removed
Default POJO implementation of
IWorkflowRunTasksForEventParams.Bean for initializing the workflow designer.
POJO implementation of
IWorkflowSoftErrorDescriptor.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.Builder for configuring a
WorkflowStateModel from a state entity.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.Converter for the
WorkflowTriggerModel.Factory methods for creating various kinds of
WorkflowTrigger models.Page model representing a collection of user triggers
Model representing a page of
BaseWorkflowTriggerResources provided by the PUBLIC REST API.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.
Represents a single line of text that has been wrapped.
Wraps an existing
IResourceDescriptor with a different URI.Represents a piece of text that has been wrapped into lines.
Deprecated.
POJO implementation of
IWriteObjectReferencesParams.Default POJO implementation of
IWritePlaceholdersParams.Model for distinguished names (DN) of certificates as defined in RFC 4514.
This is a helper bean for setting a
X.501 Distinguished Name in the GUI.Represents information about an X.509 certificate.
/** Represents a Subject Alternative Name entry with its type and value.
Information about the usage extensions of an X.509 certificate.
Details for CA certificates
Details for client authentication certificates
Details for code signing certificates
Details for document signing certificates
Details for TLS/SSL server authentication certificates
Details for S/MIME certificates
Utility methods for
Annotation.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.
Utility class for CSS files.
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.
Deprecated.
Use
XDomUtils.Utility class for
EntityManagers.Utility class for
executors.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.
Enum with the built-in properties of a form.
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.
Utility class for image operations.
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.Additional utilities for
Iterables not found in other libraries.Represents an item with an index.
Utility class for providing default languages
Utility class for locale related operations.
A predicate on a locale.
Deprecated.
Vergleicht 2 XLogAppender nach ihrem Namen.
Wrapper model for accessing/modifying logger components of Logger
PropertiesConfigurationWrapper model for Logger configs
Deprecated.
Deprecated.
Use or add methods to
XCollectionUtilsUtility class for mathematical operations.
Deprecated.
Use
ContentTypeUtils instead.Helper 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
Provider for the XSL templates available during workflow editing and validation.
Hilfsklasse für XSL-Transformationen bis Version 2.0
Utility methods for
StageChains.Additional utilities for
Streams not found in other libraries.The form element handler for text fields, i.e. a single line text input field (
<input>).Wrapper class for logging threshold filter configs
Wrapper for time based rolling file trigger policy
Helper for transforming the content of an
XUpload.Utilities for
UUID.Simple POJO implementation of
IXValidationParams.A simple POJO implementation of
IXValidationResult.