# All Classes and Interfaces

Class
Description
AbstractPrefilteredAdaptationFilter
Defines a base class for implementing a `PrefilteredAdaptationFilter`.
AccessPermission
Defines the permission to see and modify a resource.
AccessRule
Specifies a programmatic access rule.
AccessRule.NoWriteRule
Wraps another rule to return a maximum access level of read-only.
AccessRuleForCreate
Specifies a programmatic access rule invoked only when a record is created.
AccessRuleForCreateContext
Provides the context of the record creation for which the access rule is being called.
Action
Action that can be triggered by the end user.
ActionDisplaySpec
Defines whether and how an action must be displayed in a toolbar or a menu.
ActionPermission
Defines the permissions for whether or not a user can execute an action.
ActionPermissionsOnWorkflow
Defines permission rules for workflow administration and management.
ActionPermissionsOnWorkflowContext
This interface is used as the context for `ActionPermissionsOnWorkflow` execution.
ActivationContext<S extends EntitySelection>
Allows to define the activation scope and the activation rules of a user service, namely where and when this service is available and can be executed.
ActivationContextOnAssociation
Provides a context to define the activation scope and permission rules for a user service being declared on an association level.
ActivationContextOnAssociationRecord
Provides a context to define the activation scope and permission rules for a user service being declared on an associated record level.
ActivationContextOnDataset
Provides a context to define the activation scope and permission rules for a user service being declared on a dataset level.
ActivationContextOnDataspace
Provides a context to define the activation scope and permission rules for a user service being declared on a dataspace level.
ActivationContextOnHierarchy
Provides a context to define the activation scope and permission rules for a user service being declared on a hierarchy level.
ActivationContextOnHierarchyNode
Provides a context to define the activation scope and permission rules for a user service being declared on a hierarchy node level.
ActivationContextOnRecord
Provides a context to define the activation scope and permission rules for a user service being declared on a record level.
ActivationContextOnTableView
Provides a context to define the activation scope and permission rules for a user service being declared on a table level.
ActivationContextWithDatasetSet<S extends DatasetEntitySelection>
Provides common methods for activation contexts related to datasets.
ActivationContextWithSchemaNodeSet<S extends TableEntitySelection>
Provides common methods for activation contexts based on a set of schema nodes.
Adaptation
Provides a read-only access facade to data values in EBX®.
AdaptationError
This abstract class is the superclass of unchecked exceptions thrown when an dataset has an inconsistency.
AdaptationFilter
Defines a specific filter over records.
AdaptationHome
Represents a dataspace or a snapshot in a repository.
AdaptationName
Uniquely identifies a dataset or a record in a given dataspace or snapshot.
AdaptationReference
Uniquely identifies a dataset in a given dataspace or snapshot.
AdaptationTable
An instance of this class holds the records of a table node, declared as `osd:table` in the data model.
AdaptationTreeOptimizerIterator
Iterator for optimization.
AdaptationTreeOptimizerSpec
AdaptationTreeOptimizerSpec_MutualizeCommons
Specifies an optimization that refactors common values in a dataset tree.
AdaptationTreeOptimizerSpec_RemoveDuplicates
Specifies an optimization by removing duplicates in a dataset tree.
AdaptationValue
Defines a specific internal value for inheritance.
AfterCreateInstanceContext
Provides an execution context for handling post-dataset creation operations.
AfterCreateOccurrenceContext
Provides a context for executing post-record creation operations.
AfterDeleteInstanceContext
Provides an execution context for handling post-dataset deletion operations.
AfterDeleteOccurrenceContext
Provides a context for executing post-record deletion operations.
AfterDuplicateInstanceContext
Provides an execution context for handling post-dataset duplication operations.
AfterModifyInstanceContext
Provides a context for executing operations after modifying dataset fields.
AfterModifyOccurrenceContext
Provides a context for executing post-record modification operations.
AnonymousAccessEnabled
Annotation used to allow anonymous access on a given REST resource Java method.
ApplicationConfigurator
Provides methods to register specific REST Toolkit JAX-RS application components and package scan boundaries.
ApplicationConstant
This interface provides constants for JAX-RS applications configuration.
Archive
An instance of this class references an archive used to export data from / import data to EBX® repositories.
ArchiveExportSpec
Defines the settings of an archive export.
ArchiveImportSpec
Defines the settings of an archive import.
ArchiveImportSpecMode
Defines the strategy used for importing an archive.
AssociationEntitySelection
Provides information on the current selection, in the context of an association.
AssociationLink
This interface contains the information for an association link (`osd:association` property).
AssociationLinkByLinkTable
This interface contains the information for an association over a link table (`osd:association/linkTable` property).
AssociationLinkByTableRefInverse
This interface contains the information for an association that is the inverse of a foreign key (`osd:association/tableRefInverse` property).
AssociationLinkByXPathLink
This interface contains the information for an association that is over an XPath predicate (`osd:association/xpathLink` property).
AssociationRecordEntitySelection
Provides information on the currently selected associated record.
AssociationTableEntitySelection
Provides information on the association context of the current selection.
AuthenticationException
Authorization
Annotation used to apply a specified `AuthorizationRule` on REST resource Java methods.
AuthorizationContext
Context providing useful information for checking authorization on REST resources.
AuthorizationOutcome
Defines the authorization for whether or not a user can access a REST resource.
AuthorizationRule
A rule restricting access to the requested REST resource.
Batch
This interface describes a batch that can be executed in a "serverless" environment or a JEE container.
BatchLauncher
This class is used to launch `Batch`.
BeanDefinition
This interface is used to define the schema associated with a non-persistent bean object (as opposed to a record or a dataset).
BeanDefinitionException
This runtime exception is thrown by some methods related to the dynamic beans schema definition.
BeanElement
This interface allows setting properties of a data model element.
BeanFacet
This interface allows setting properties of a bean facet.
BeanFacetDatasetSet
This interface allows setting the properties of a dataset constraint facet.
BeanFacetDataspaceSet
This interface allows setting the properties of a dataspace constraint facet.
BeanFacetTableRef
This interface allows setting the properties of a foreign key facet.
BeforeCreateInstanceContext
Provides an execution context to handle pre-dataset creation operations.
BeforeCreateOccurrenceContext
Provides a context for executing pre-record creation operations.
BeforeDeleteInstanceContext
Provides an execution context for handling pre-dataset deletion operations.
BeforeDeleteOccurrenceContext
Provides a context for executing pre-record deletion operations.
BeforeModifyInstanceContext
Provides a context for executing operations before modifying dataset fields.
BeforeModifyOccurrenceContext
Provides a context for executing pre-record modification operations.
BeforeTransactionCancelContext
Provides a context for executing pre-transaction cancellation operations.
BeforeTransactionCommitContext
Provides a context for executing pre-transaction commit operations.
BranchKey
Identifies a dataspace in a repository.
BuiltinQueryParam
This interface specifies the HTTP built-in query parameters of the REST Toolkit.
BuiltInTrigger_launchWorkflow
Built-in trigger to start a workflow and initialize its context.
BuiltInTrigger_launchWorkflow.IncomingEvent
Represents the event that launched the workflow.
BusinessObjectModel
Represents the definition of a business object in the context of a data model.
BusinessObjectModelRelationship
Represent a relationship in the context of a business object model.
CategoryURIBuilder<T extends URIBuilderForBuiltin<T>>
Maps each REST category and available version to their related URI builder.
CategoryVersion
This enumeration provides built-in EBX® category version services.
ChildEntity
Provides a read-only access facade to a record related to the main record of a business object.
CompareFilter
Defines a filter that can be applied to a specific comparison.
Condition
Condition node; its purpose is to evaluate which fork the process must take.
ConditionBean
This abstract class must be extended in order to define a library condition.
ConditionBeanContext
This interface is used as the context for `ConditionBean` evaluation.
ConditionContext
This interface is used as the context for `Condition` evaluation.
Constants
This interface provides constants for the built-in RESTful services.
Constants.Admin
Administration report keys, parameters and operation name.
Constants.Auth
Authentication report keys, parameters and operation name.
Constants.Constraint
Constraint keys and values.
Constants.Data
Data keys and parameters.
Constants.Dataspace
Dataspace keys and parameters.
Constants.DeleteReport
Deletes report keys.
Constants.Error
Exception handling keys.
Constants.FormData
Form-data keys and parameters
Constants.Health
Specifies the health keys.
Constants.History
History keys and parameters.
Constants.Meta
Meta keys and parameters.
Constants.Pagination
Pagination keys and parameters.
Constants.ProcedureContext
Procedure context keys.
Constants.Selector
Selector keys and parameters.
Constants.ValidationReport
Validation report keys.
Constraint<T>
Specifies a constraint that may be contextual and dynamic.
ConstraintContext
Provides methods for setting up a constraint in the context of its data model.
ConstraintContextOnTable
Provides methods for setting up a constraint on a table in the context of its data model.
ConstraintEnumeration<T>
Specifies an enumeration constraint that can be contextual and dynamic.
ConstraintNomenclature
Deprecated.
Since `enumeration constraint` is more appropriate than this interface when there are many values in the enumeration or when display must be localized.
ConstraintOnNull
Defines a verification for values that are mandatory under certain circumstances.
ConstraintOnTable
Specifies a constraint that is able to perform the validation of an entire table.
ConstraintOnTableWithRecordLevelCheck
Defines a record-level check, to be performed in addition to table-level checks.
ConstraintViolationException
Thrown to indicate that an insert, an update or a delete is not valid with respect to a blocking constraint.
ContentHolder
Provides a facade to a table record in EBX®.
ContentHolderForInput
Provides a facade to automatically parse a part of the request body that may represent a table record.
ContentHolderForOutput
Provides a facade to automatically serialize an `Adaptation`, that corresponds to a table record, into a JSON response body.
ConversionException
This exception is thrown whenever a conversion problem occurs.
CreationWorkItemSpec
This class specifies the properties of a work item to be created.
D3Broadcast
The broadcast handler contains the information used in the broadcast distributed transaction.
D3Broadcast.Status
Global status of the snapshot broadcast operation.
D3Engine
Deprecated.
Since 5.4.2, this method has been replaced by `D3NodeAsMaster`.
D3Node
Represents the external view of the D3 engine and offers common administrative functionalities.
D3NodeAsMaster
Represents the external view of the D3 engine and offers primary administrative functionalities.
D3NodeAsSlave
Represents the external view of the D3 engine and offers replica administrative functionalities.
D3NodeAsSlaveOnStartup
Context having specific repository privileges to set up a D3 replica node, during EBX® module registration.
D3NodeFactory
Factory for creating a D3 engine depending on the node type chosen (primary or replica), which offers D3 administrative functionalities.
D3ReceiveBroadcastAfterContext
Provides a context for executing post-broadcast operations.
D3ReceiveBroadcastBeforeContext
Provides a context for executing pre-broadcast operations.
D3ReceiveBroadcastExecutionContext
Common super interface that provides an execution context for D3 broadcast triggers.
D3ReceiveBroadcastTrigger
Specifies methods that are automatically invoked when receiving broadcast from the D3 primary node.
D3Slave
D3 replica node information.
D3Slave.State
Represents the state of the replica repository.
DatabaseMapping
This interface allows interacting with the name of columns in the database.
DataContext
The data context is a container for variables which must be kept during the whole process.
DataContextReadOnly
The data context is a container for variables which must be kept during the whole process.
DataModelBusinessObjectModels
Holds the `business object models` defined in a data model.
DatasetEntitySelection
Provides information on the currently selected dataset.
DatasetSet
Declarative definition of a set of dataspaces thanks to a list of include and exclude subsets.
DatasetSet.DatasetChildrenPolicy
Inclusion policies for the children of a current dataset in a current subset.
DatasetSetFilter
This interface defines a filter to accept or reject datasets in the context of a field of type `SchemaTypeName.OSD_DATASET_NAME`.
DatasetSetFilterContext
Provides methods for filtering datasets in the context of a dataset selector.
DatasetSetFilterSetupContext
Provides methods for setting up a dataset filter in the context of its data model.
DataspaceEntitySelection
Provides information on the currently selected dataspace.
DataspaceSet
Declarative definition of a set of dataspaces thanks to a list of include and exclude subsets.
DataspaceSet.DataspaceChildrenPolicy
Inclusion policies for the children of a current dataspace in a current subset.
DataspaceSet.DataspaceType
Defines all the types that a dataspace can be.
DataspaceSetFilter
This interface defines a filter to accept or reject dataspaces in the context of a field of type `SchemaTypeName.OSD_DATASPACE_KEY`.
DataspaceSetFilterContext
Provides methods for filtering a dataspace in the context of a dataspace selector.
DataspaceSetFilterSetupContext
Provides methods for setting up a dataspace filter in the context of its data model.
DataspaceValidationReport
Defines the validation report of a dataspace.
DefaultViewMode
List of default view modes used to define how a group or association is displayed.
DefinitionMode
Defines the possible inheritance modes for a record.
DeliveryMode
Defines the D3 delivery modes.
DependenciesDefinitionContext
Provides methods for setting dependencies in the context of a constraint and its data model.
Difference
Main abstract class for representing differences between two entities.
DifferenceBetweenContents
Abstract class for representing differences between two datasets or two records.
DifferenceBetweenHomes
Main class for comparing dataspaces and snapshots.
DifferenceBetweenInstances
Represents the difference between two datasets.
DifferenceBetweenOccurrences
Represents the difference between two records.
DifferenceBetweenTables
Represents the difference between two tables.
DifferenceHelper
This class is the common entry point for performing data comparisons.
Directory
Defines the user directory used by EBX® to authenticate users and to define users and their roles.
DirectoryDefault
The default internal directory implementation that is delivered with EBX®.
DirectoryDefault.RoleEntity
Represents a role entity that is, or can be, persisted in the default directory.
DirectoryDefault.UserEntity
Represents a user entity that is, or can be, persisted in the default directory.
DirectoryDefaultFactory
The factory for the default internal implementation of the user and roles directory that is delivered with EBX®.
DirectoryDefaultHelper
Helper class that works with `DirectoryDefault` class.
DirectoryFactory
Factory for the user and roles directory.
DirectoryHandler
An instance of this class wraps the current custom directory implementation, so as to add pre-processing and post-verifications to the directory method implementations.
DisplayDensity
Represents the display density mode.
DisplayMode
Defines how a toolbar action has to be displayed on launch.
DisplayMode.ModalCustom
Indicates that the modal should be of the specified custom size.
DisplayMode.ModalMedium
Indicates that the modal should be of the built-in medium size.
DisplayMode.Workspace
Indicates that the action should be displayed in the workspace.
Documentation
Annotation used to document the purpose of a JAX-RS matched resource.
Encryption
Defines an interface for an encryption class.
EncryptPassword
Provides a EBX® Default Directory Utility to encrypt a user password.
Entity
Provides a read-only access facade to a record of a business object.
EntitySelection
Provides information on the current selection.
ExplicitRelationship
Represents an explicit relationship defined in a resolved data model.
ExportImportCSVSpec
Defines the settings for executing an import or export to "Comma-separated values" format (CSV).
ExportImportCSVSpec.Header
Specifies the header type of the CSV document.
ExportSpec
Defines the settings of an export.
ExtendedInput
An annotation used to configure the extended JSON input format for a Data Transfer Object (DTO) field of type `ContentHolder`.
ExtendedOutput
Annotation used to configure the extended JSON output format for a Data Transfer Object (DTO) field of type `ContentHolder`.
ExtraAdaptationOnLeft
Represents a dataset that exists on the left but not on the right.
ExtraAdaptationOnRight
Represents the case where a dataset exists on the right but not on the left.
ExtraInstance
ExtraInstanceOnLeft
Represents the case where a dataset exists in the dataspace on the left but not in the dataspace on the right.
ExtraInstanceOnRight
Represents the case where a dataset exists in the dataspace on the right but not in the dataspace on the left.
ExtraOccurrence
ExtraOccurrenceOnLeft
Represents the case where a record is defined in the table on the left side not in the table on the right side.
ExtraOccurrenceOnRight
Represents the case where a record is defined in the table on the right side but not in the table on the left side.
FirstCallDisplay
Defines how to display a filtered table or record in a Web Component on first call.
HashComputation
Defines an interface to compute the hash of a password.
HierarchyEntitySelection
Provides information on the currently selected hierarchy.
HierarchyNode
Represents a node in a hierarchy.
HierarchyNodeEntitySelection
Provides information on the currently selected hierarchy node.
HomeCreationSpec
Specifies the features of a dataspace or snapshot to be created.
HomeKey
Abstract superclass for dataspace and snapshot identifiers.
IllegalInteractionStateException
This runtime exception is thrown by some methods which try to change the interaction state while the current interaction state has already been accepted or rejected.
ImportResult
Describes the result of an import.
ImportSpec
Defines the settings of an import.
ImportSpecMode
Defines the possible modes for an XML import.
Include
Holds the available options for configuring the content of the generated JSON response body.
IncompatibleChangeError
Unchecked exception thrown when the repository or the underlying data model has changed and this change implies that the current operation cannot be completed successfully.
InstanceContentSpec
Specifies the content to export from a dataset.
InstanceTrigger
Specifies methods that are automatically executed when certain operations are performed on a dataset.
InstanceTriggerExecutionContext
Common abstract superclass that provides an execution context for dataset triggers.
InteractionException
This runtime exception is thrown by some methods related to interactions.
InteractionHelper
This class provides methods for implementing a user service that has been declared as an interaction.
InteractionHelper.ParametersMap
Defines the parameters of an interaction, either the input, output or internal parameters.
InvalidChangeError
Deprecated.
No more used since 5.2.6.
InvalidPrimaryKeyException
Exception thrown when a `PrimaryKey` does not respect the syntax of the internal `String` representation of primary keys.
InvalidSchemaException
Thrown to indicate that a data model is not valid.
JavaBeanVersion
Defines a JavaBean behavior version.
JavaScriptAction
Defines an action that runs a JavaScript expression.
JavaScriptCatalog
This interface is only used to document JavaScript functions and should not be referenced by Java code.
JavaScriptCatalog.EBX_ValidationMessage
A JavaScript object that holds a list of messages with different severities.
JavaScriptCatalog.EbxHtmlButtonElement
Represents an HTML button generated by EBX® using a Java `UIButtonSpec` object.
JsFunctionCall
Instances of this class specify a call to a JavaScript function to be performed on the client side.
LdapDirectoryFactory
Built-in LDAP directory factory for EBX®.
LocalizedException
Class that can be extended by exceptions that return a localized error message.
LockSpec
Handles a lock on a dataspace.
LoggingCategory
This class provides methods for logging messages according to their severities.
MailSpec
This interface provides the possibility to send emails in a workflow context.
MailSpec.ContentType
MailSpec.NotificationType
Indicates the notification type.
MainEntity
Provides a facade to the main record of a business object.
MalformedXPathExpressionException
Thrown when an XPath expression is malformed.
MergeSpecForHome
Specifies the contents of a dataspace to be merged.
MergeSpecForInstanceContents
Specifies the contents to be merged for a dataset.
ModuleContextOnRepositoryStartup
Context for the registration of a module, invoked at the initialization of the EBX® repository.
ModuleDefinitionException
Exception thrown when a module cannot be registered properly.
ModuleInitializedContext
Context for the registration of dynamic resources and module-specific initializations.
ModuleNotFoundException
Thrown to indicate that a specified module (web application) has not been registered in the current environment.
ModuleRegistration
Ensures the EBX® module registration.
ModuleRegistrationAdvancedD3
Completes module registration so as to be able to properly set up the required environment of a D3 replica node.
ModuleRegistrationListener
Ensures the EBX® module registration from a servlet context listener.
ModuleRegistrationServlet
Ensures the EBX® module registration from a HTTP servlet.
ModuleSearchRegistrationContext
Context for registering custom search resources in EBX®.
ModuleServiceRegistrationContext
Context for registering the new module user services and the user service extensions in EBX®.
ModulesRegister
This class has been replaced by `ModuleRegistrationServlet`.
NewRecordContext
Context providing information on a record creation.
NewTransientOccurrenceContext
Provides a context for preparing a transient record context upon record creation.
NodeDataTransformer
This class allows the transformation of data.
NodeDataTransformerContext
Context used to transform data upon export.
NodeDifference
Represents the finest granularity of comparison, which is the difference between the values of two nodes in a dataset or a record.
NodeMonitoring
Listener interface that runs on a replica node to perform specific actions when the replica status switches to the states 'Available' or 'Unavailable'.
NodeMonitoringContext
Common interface providing an execution context for replica node monitoring.
Nomenclature<T>
A `Nomenclature` is an ordered collection of `NomenclatureItem` instances.
NomenclatureItem<T>
A `NomenclatureItem` associates a value with one or more labels.
NomenclatureItemValue<T>
A `NomenclatureItemValue` is a label value in a containing `Nomenclature`.
ObjectKey
Identifies an object from a given context.
OpenApiApplicationPath
Annotation used to automatically create a JAX-RS application serving OpenAPI REST resource for the underlying REST Toolkit application.
OpenApiResource
Annotation used to activate the OpenAPI documentation on the annotated REST resource Java class.
OperationException
Thrown to indicate that an operation cannot complete normally.
Path
A path is used for locating a node in a tree structure.
PathAccessException
Thrown when a path cannot be resolved in a data model.
Perspective
Interface that provides information about a perspective.
PerspectiveAction
Interface that represents the action of a perspective item.
PerspectiveActionItem
Interface that represents a perspective action item.
PerspectiveHandler
An instance of this class offers methods to retrieve the perspectives defined in the current repository.
PerspectiveIcon
Interface that represents an icon of a perspective menu item.
PerspectiveIconType
Enumerates the different types of icons.
PerspectiveItem
Interface that represents a perspective item.
PerspectiveItemContainer
Interface representing an item that can have children.
PerspectiveItemType
Lists the different items of the perspective menu.
PerspectiveItemWithIcon
Interface that represents an item that can have an icon.
PerspectiveSectionItem
Interface that represents an item of a perspective section.
PerspectiveTheme
Interface that represents a perspective theme.
PrefilteredAdaptationFilter
Defines an `AdaptationFilter` that can be optimized using a prefilter predicate.
PrimaryKey
An instance of a `PrimaryKey` uniquely identifies a record in a `table`.
Procedure
This interface must be implemented in order to update data in a dataspace.
ProcedureContext
Context to execute EBX® transactions.
ProcedureResult
Represents the result of a procedure execution.
ProcedureUtility
This class eases `Procedure` execution through automatic pre-configuration.
ProcessExecutionContext
This interface is used as a base interface for workflow context.
ProcessExecutionContext.WorkflowPermission
Represents the permissions associated with the workflow model.
ProcessExecutionInfoContext
This interface is used as a generic context for workflow execution to get information about the current process instance.
ProcessInstance
Represents a workflow and provides related information.
ProcessInstanceComment
Represents a comment of a workflow.
ProcessInstanceHistory
Interface that represents the history of a workflow.
ProcessInstanceHistory.TerminationType
ProcessInstanceKey
Identifies a process instance.
ProcessInstanceStep
Represents a step of a process instance.
ProcessInstanceStep.WaitTaskState
Represents the different states of a wait task.
ProcessLauncher
Prepares and launches a workflow instance.
ProcessLauncherResult
Represents the result of a workflow instance launcher
Profile
Identifies a user profile for permission management.
ProfileListContext
This class is used by a user and roles directory to customize the profiles that a user can select.
ProgrammaticService
This class provides the ability to programmatically log a user session.
PublicationSpec
Specifications for publishing a single workflow.
PublicationSpec.PublicationMode
Retrieves the mode of the publication.
PublishedProcess
Represents a workflow publication and provides information about it.
PublishedProcessKey
Identifies a specific publication of a process definition.
Query<T>
An object that represents a compiled and validated SQL query.
QueryBuilder
A builder for query objects, capable of creating queries which reference tables from multiple datasets.
QueryParseException
Thrown if a SQL query string cannot be parsed.
QueryPermissionException
This exception is thrown when a query fails because some nodes are not visible for the user.
QueryResult<T>
Represents the result of a query.
ReadContext
Provides a read-access facade to objects in a tree structure conforming to an underlying data model.
ReadOnlyProcedure
Interface to be implemented for read-only transactions.
RecordEntitySelection
Provides information on the currently selected record.
RefreshPolicy
Represents the refresh policy of a `ReplicationUnit`.
Relationship
An instance of this class specifies a relationship between nodes in the same dataset or in another dataset.
RelationshipsHelper
Provides utility methods for accessing directly from a record to the result of a relationship.
Replica
Represents a replica in a replication unit.
ReplicaForList
Represents a replica of an aggregated list in a replica table.
ReplicaTable
Represents a replica table in a replication unit.
ReplicationUnit
A replication unit is defined by the data model.
ReplicationUnitKey
Identifies a replication unit defined in a data model.
Repository
Represents the data repository in EBX®.
RepositoryAccessException
Thrown when a technical problem occurs while accessing data, for example, due to unavailable resources.
RepositoryAnonymizer
Allows anonymizing records.
RepositoryAnonymizer.RecordContext
Provides access to a record to be anonymized, granting the privilege to modify the value of its fields.
RepositoryDeclaration
Provides general management information about a repository.
RepositoryId
Identifies a repository in a persistent manner.
RepositoryPurge
Defines the administrative actions for purging a repository.
RepositoryStatus
Defines the status of a repository regarding the ownership of the database.
RepositoryStatus.State
Request
Defines a specific request on a table.
RequestPagination
Performs paged navigation upon a request.
RequestPagination.Page
Represents a page over a request.
RequestResult
Represents the result of a `Request`.
RequestSortCriteria
Specifies sort criteria to be associated with a request.
ResourceType
Identifies a type of packaged resource.
ResourceType
Identifies a type of packaged resource.
RESTApplicationAbstract
Defines the components for a REST Toolkit JAX-RS application.
RestConstants
Deprecated.
replaced by `Constants`
RESTEncodingHelper
Deprecated.
since 6.1.0.
ReverseRelationship
Represents a reverse relationship in a resolved data model.
ReverseRelationshipInterDataset
Represents a reverse relationship in a resolved data model where the node that defines the foreign key constraint, the selection link or the association link is in another dataset.
ReverseRelationshipIntraDataset
Represents a reverse relationship in a resolved data model where the node that defines the foreign key constraint, the selection link or the association link is in the same dataset.
ReverseRelationshipResult
Represents the result of a reverse relationship.
ReverseRelationshipResultInDataspace
Represents the result of a reverse relationship in a specific dataspace.
ReverseRelationshipResultsInterDataset
Represents the result of a reverse relationship where the node that defines the foreign key constraint, the selection link or the association link is in another dataset.
Role
A role is a profile that is not a reference to a specific user; several users can have the same role.
ScheduledExecutionContext
Context of a scheduled task execution.
ScheduledTask
Task definition to be executed by the EBX® task scheduler.
ScheduledTaskInterruption
Thrown to interrupt a `ScheduledTask`.
SchemaDefaultTableView
This interface represents the default view properties of a table defined in the data model.
SchemaDocumentation
Abstract class for dynamically computing the label and description of a node in the context of a data model.
SchemaDocumentationContext
This class provides the context used for computing the label and description associated with a node in a data model.
SchemaDocumentationSetupContext
Provides methods for setting up the documentation of a data model.
SchemaExtensions
Defines extensions of a data model.
SchemaExtensionsContext
Context for specifying extensions of a data model.
SchemaFacet
Common interface for constraints on data types (also known as constraining facets in XML Schema).
SchemaFacetBlocksCommit
Represents the blocking policy defined by a facet using the property `osd:validation/blocksCommit`.
SchemaFacetBoundary
This interface represents the `maxExclusive`, `maxInclusive`, `minExclusive`, and `minInclusive` facets associated with a node.
SchemaFacetBoundaryMaxExclusive
This interface represents the `maxExclusive` facet associated with a node.
SchemaFacetBoundaryMaxInclusive
This interface represents the `maxInclusive` facet associated with a node.
SchemaFacetBoundaryMinExclusive
This interface represents the `minExclusive` facet associated with a node.
SchemaFacetBoundaryMinInclusive
This interface represents the`minInclusive` facet associated with a node.
SchemaFacetEnumeration
This interface represents enumeration facets associated with a node.
SchemaFacetExcludeSegment
This interface represents the `excludeSegment` facet associated with a node.
SchemaFacetExcludeValue
This interface represents the `excludeValue` facet associated with a node.
SchemaFacetFractionDigits
This interface represents the `fractionDigits` facet associated with a node.
SchemaFacetLength
This interface represents the `length` facet associated with a node.
SchemaFacetMaxLength
This interface represents the `maxLength` facet associated with a node.
SchemaFacetMinLength
This interface represents the `minLength` facet associated with a node.
SchemaFacetOnLength
This interface declares the common methods related to the facets `length`, `minLength` and `maxLength` associated with a node.
SchemaFacetOnMandatoryField
This interface corresponds to a cardinality constraint on a mandatory field (defines both `minOccurs="1"`and `maxOccurs="1"`).````
SchemaFacetOResource
This interface represents the `resource` constraint associated with a node (`osd:FacetOResource`).
SchemaFacetPattern
This interface represents the `pattern` facet associated with a node.
SchemaFacetTableRef
This interface represents the foreign key constraint associated with a node (`osd:tableRef`).
SchemaFacetTotalDigits
This interface represents the `totalDigits` facet associated with a node.
SchemaFacetValidationMessage
Represents the validation messages defined by a facet in a data model.
SchemaFacetValidationPolicy
Represents the validation policy defined by a facet using the property `osd:validation`.
SchemaInheritanceProperties
This interface represents the inheritance properties defined in the data model on a node defining the property `osd:inheritance`.
SchemaLinkedField
This interface contains the information for a linked node (node that defines `osd:function linkedField="aPath"` property).
SchemaLocation
Identifies a data model location, which can be either based on a URL (standard notation) or a module.
SchemaMetadataConstants
This interface contains the `paths` to the nodes that hold the metadata associated to table records.
SchemaNode
Represents an element declaration in the resolved data model.
SchemaNodeBreadcrumbProperties
Represents the `breadcrumb` element associated with a table, a foreign key or an association node in a resolved data model.
SchemaNodeContext
This interface defines common services for performing a validation task on an entity associated with a `data model node`.
SchemaNodeDefaultView
Represents the `osd:defaultView` element associated with a node in a resolved data model.
SchemaNodeExplicitRelationship
This interface represents a relationship defined in a resolved data model.
SchemaNodeInformation
Represents the `osd:information` element associated with a node in a resolved data model.
SchemaNodeRelationships
Contains all the relationships held by a node in a resolved data model.
SchemaTypeName
Identifies a named type definition.
ScriptTask
Script task node, represents an automatic task during a process execution.
ScriptTaskBean
This abstract class must be implemented in order to define a library script task.
ScriptTaskBeanContext
This interface is used as the context for `ScriptTaskBean` execution.
ScriptTaskContext
This interface is used as the context for `ScriptTask` execution.
SearchStrategyKey
Identifies a search strategy.
SearchTemplate
The main interface to implement for a search template.
SearchTemplateKey
Identifies a search template.
SearchTemplateManager
Provides access to the declared search templates.
SelectionLink
This interface contains the information for a selection link (`osd:select` property).
ServiceActionInCurrentContext
Defines a user service call that can be used on a toolbar element with an action.
ServiceActivationRuleForDataset
This interface can be implemented to dynamically figure out whether a user service is globally disabled on a dataset and/or a dataspace.
ServiceActivationRuleForDatasetContext
Provides the context in which a service restriction rule is being evaluated.
ServiceActivationRuleForDataspace
This interface can be implemented to specify whether a user service is disabled for a given dataspace.
ServiceActivationRuleForDataspaceContext
Provides the context in which a service restriction rule is being evaluated.
ServiceContext
Deprecated.
From release 6.0, this API is no longer supported.
ServiceGroupKey
Identifies a group of user services.
ServiceKey
Identifies a user service.
ServicePermission
Attached to a legacy user service definition, this interface specifies the conditions under which this service can be executed.
ServicePermissionForHierarchy
Attached to a legacy user service definition, this interface specifies the conditions under which this service may be executed in the context of a hierarchy.
ServicePermissionRule<S extends EntitySelection>
This interface can be implemented to specify the conditions under which a user service can be displayed and executed.
ServicePermissionRuleContext<S extends EntitySelection>
Provides the context in which a service permission rule is being evaluated.
Session
Represents an authenticated user session, either an HTTP session or a "programmatic" session.
SessionContext
This interface provides EBX® information for the current REST request.
SessionInteraction
A session interaction is tightly associated to a work item to represent its running state.
SessionInteraction.DecisionResult
Contains the report of a decision request (accept or reject).
SessionInteraction.Specification
Gives information about the specification of the interaction.
SessionPermissions
Defines a facade for checking the user's session permissions (access rights or actions) on dataspaces, snapshots, datasets, records, and nodes (tables, ...).
Severity
This enumeration class defines the possible severity levels of user messages.
Size
The size object is used to specify the size of a few form components.
Size.Unit
Step
A path is a sequence of steps.
StgPermissionsBridge
Deprecated.
since 6.2.1 and will be removed in the next release.
StopWordsDeclaration
This interface represents a list of stop words to be declared in a module.
StopWordsKey
Identifies a stop word list.
SubWorkflowsCompletionContext
Provides the context when all launched sub-workflows have completed.
SubWorkflowsCreationContext
Provides the context for launching the sub-workflows of a step.
SubWorkflowsInvocationBean
This abstract class must be extended in order to define a specific sub-workflow invocation.
SynonymDeclaration
This interface represents a list a synonyms to declare in a module.
SynonymPair
Represents a pair of synonyms.
SynonymsKey
Identifies a Synonyms list.
Table
Annotation used to reference a schema table linked to a Data Transfer Object (DTO) field of type `ContentHolder`.
TableEntitySelection
Provides information on the currently selected table.
TableRefDisplay
Defines a custom renderer for displaying a foreign key constraint depending on the context of a node.
TableRefDisplayContext
Provides methods for setting up a `TableRefDisplay` in the context of its data model.
TableRefFilter
Defines a filter that depends on the context of a constraint.
TableRefFilterContext
Provides methods for setting up a `TableRefFilter` in the context of its data model.
TableTrigger
Specifies methods that are automatically executed when certain operations are performed on a table.
TableTriggerExecutionContext
Common abstract superclass that provides an execution context for table triggers.
TableViewEntitySelection
Provides information on the currently selected table and on the current record selection if any.
TestHelper
This class can be used to write JUnit tests for EBX®.
TileDescription
Provides information on tile view description.
TileImage
Provides information on tile view Image.
Toolbar
Allows to define a toolbar.
ToolbarActionButton
Allows to define a toolbar action button.
ToolbarActionMenuItem
Allows to define an action menu item.
ToolbarButton
Allows to define a toolbar button.
ToolbarElementWithAction
Defines a toolbar element on which the end user can trigger a specific action.
ToolbarFactory
Allows to create a new toolbar.
ToolbarLocation
Possible locations of a toolbar.
ToolbarMenu
Allows to define a menu.
ToolbarMenuButton
Allows to define a toolbar menu button.
ToolbarMenuGroup
Allows to define a group menu item.
ToolbarMenuItem
Allows to define a menu item.
ToolbarSubMenuItem
Allows to define a sub menu item.
TriggerExecutionContext
Common abstract superclass that provides an execution context for triggers.
TriggerSetupContext
Provides methods for setting up a trigger in the context of its data model.
Tuple
Interface for extracting the elements of a query result tuple.
UIAjaxComponent
Abstract class for implementing an Ajax component.
UIAjaxContext
Encapsulates an HTTP response so that an Ajax component is able to generate its part of the DHTML page.
UIAtomicWidget
This interface is common to all EBX® model-driven widgets based on a single data model field.
UIAtomicWithEnumeration
This interface is common to all EBX® model-driven widgets based on a single data model enumerated field.
UIAtomicWithEnumerationItem
This interface represents an item in the parent interface `UIAtomicWithEnumeration`, which corresponds to an index in the enumeration.
UIBeanEditor
Deprecated.
From 5.8.0, please use the new API `UICustomWidget` instead.
UIBeanEditorV4
Deprecated.
To use only for backward compatibility of `UIBeanEditor` implementations written in versions 4.x.
UIBodyWriter
This interface provides methods for adding text to the body of a document.
UIButtonIcon
This class is used to set the icon of a button.
UIButtonLayout
This class can be used to set the layout of a button.
UIButtonRelief
This class provides different ways to display the relief of a button.
UIButtonSpec
This abstract class provides the common features for different types of buttons.
UIButtonSpecJSAction
Standard button to launch a JavaScript command.
UIButtonSpecJSActionToggle
Standard toggle button that calls a JavaScript command for each change of state.
UIButtonSpecNavigation
This abstract class provides the common features for buttons that can redirect current user.
UIButtonSpecSubmit
In the context of User services, specifies an HTML submit button.
UIButtonSpecURL
Standard button to redirect user to a given URL.
UICheckBox
This interface represents a checkbox corresponding to an index in an enumeration.
UICheckBoxGroup
Group of checkboxes based on an enumeration.
UIColorPicker
This interface represents a color picker which is composed of a preview box, an input and a button.
UIComboBox
Combo box composed of a drop-down list and a text box to filter the list.
UIComponentWriter
This interface offers common user interface methods to create standard EBX® components.
UIContext
Deprecated.
, @see `UICustomWidget`
UICSSClasses
This class defines all CSS classes usable for User services, UI beans and `FormPane`s.
UICSSClasses.DIALOG_BOX
UICSSClasses.ICONS
All the CSS classes used to display standard icons.
UICSSClasses.TABLE
For basic tables (`<table>`, `<tr>`, `<th>` and `<td>` containing data).
UICSSClasses.TEXT
All the CSS classes used to display standard text styles.
UICSSUtils
This class defines server-side CSS utilities.
UICustomViewContext
Provides information on custom view context.
UICustomViewKey
Provides information on custom view key.
UICustomViewKeyFactory
Provides factory methods to create `UICustomViewKey`s.
UICustomWidget
Base class for custom widgets.
UIDatasetSelector
A widget made of a combo box displaying the dataset tree and a text box for filtering.
UIDataspaceSelector
A widget made of a combo box displaying the dataspace tree and a text box for filtering.
UIDateTime
Date/time field.
UIDependencyRegisterer
This interface provides methods to add dependencies to resource files in the current response context.
UIDropDownList
Simple HTML drop-down list.
UIExpandCollapseBlock
In the context of a form, specifies an expand/collapse block specification.
UIForm
This abstract class is the entry point for implementing a custom record form.
UIFormBody
Allows defining the body of a custom form.
UIFormBottomBar
The bottom bar of a form can be composed of four buttons: Close Revert Save Save & Close
UIFormContext
Context provided by the user interface container that helps when defining the various parts of a custom form.
UIFormGroup
In the context of a form, specifies a group of form rows or form groups with an indentation.
UIFormGroup.DisplayMode
A form group can have several display modes.
UIFormHeader
Allows defining the header of a custom form.
UIFormLabelSpec
Specifies a label to display and optional additional documentation, accessible in a pop-up.
UIFormLabelSpec.DocumentationPane
Describes the content of a documentation pane.
UIFormNode
In the context of a form, specifies a record node in a row.
UIFormNode.DisplayMode
Represents the display policy of a node.
UIFormPane
Allows to define an HTML content.
UIFormPaneFromPathList
This pane provides a table with a list of simple fields/complex groups.
UIFormPaneWithTabs
This layout divides the form into a set of `tabs`.
UIFormPaneWithTabs.Tab
This class offers a tab to have a `UIFormLabelSpec` for the title and thus can have a `UIFormLabelSpec.DocumentationPane`.
UIFormPaneWriter
Encapsulates an HTTP response so that a form layout is able to generate its part of the page, including the building of standard model-driven widgets.
UIFormRequestContext
Encapsulates an HTTP request so that a custom form can provide the user input validation context.
UIFormRow
In the context of a form, specifies a row composed of an icon, a label and a user input area (or display area, if in read-only mode).
UIFormRowIcon
This class can be used to set a built-in icon at the beginning of a form row.
UIFormSpec
In the context of User services, specifies the general features of an HTML form.
UIFormWriter
This interface offers methods useful to create standard EBX® forms.
UIHierarchicalView
Provides information on hierarchical view.
UIHttpManagerComponent
This class is a utility for invoking user interface components using the HTTP protocol.
UIHttpManagerComponent.CloseButtonSpec
Defines the appearance of the close button.
UIHttpManagerComponent.DataSetFeatures
Constants for features available in dataset.
UIHttpManagerComponent.RecordFeatures
Constants for features available in record form.
UIHttpManagerComponent.Scope
Defines the scope of the user navigation, namely, the parts of the user interface that are available to the user during the session.
UIHttpManagerComponent.ViewFeatures
Constants for features available in tables and hierarchies.
UIHttpManagerComponentHelper
UIHttpManagerComponentReturnCode
Represents the return code of a user interaction initiated by `UIHttpManagerComponent`.
UIJavaScriptWriter
This interface provides methods to add JavaScript in the current response context.
UILabelRenderer
Interface for displaying a record in a table or a foreign key constraint.
UILabelRendererContext
Provides a context for displaying a record.
UILabelRendererForHierarchy
Interface for presenting a hierarchy node inside a hierarchy tree.
UILabelRendererForHierarchyContext
Provides a context for displaying a hierarchy node.
UIListBox
Simple HTML list box, with multi-selection.
UIListCustomWidget
Base class for custom widgets handling whole list elements.
UIPassword
Password field.
UIRadioButton
This interface represents a radio button corresponding to an index in an enumeration.
UIRadioButtonGroup
Group of radio buttons based on an enumeration.
UIRenderer
Provides a common interface for computing labels.
UIRenderingMode
Defines the rendering mode of the UI.
UIRequestContext
Deprecated.
From 5.8.0, please use the new API `UICustomWidget` instead.
UIResourceLocator
This interface defines methods to build URLs that change the entity in the current navigation context and access various types of resources (Web Component, Ajax component, static web resources).
UIResponseContext
Deprecated.
From 5.8.0, please use the new API `UICustomWidget` instead.
UIServiceComponentWriter
Deprecated.
From release 6.0, this API is no longer supported.
UISessionContext
This interface provides methods for retrieving a user session from a user interface component.
UISimpleCustomWidget
Base class for custom widgets handling non-list elements.
UITable
This interface represents a table component.
UITableCellStyleHandler
This class is used to define table cell styles for a UI bean editor.
UITableCellStyleHandler.BackgroundRepeat
UITableFilter
Abstract class for implementing a user interface filter on a table.
UITableFilterContext
Common interface for contexts used by a `UITableFilter`
UITableFilterRequestContext
Encapsulates an HTTP request in order to set up a filter.
UITableFilterResponseContext
Encapsulates an HTTP request in order to display a table filter.
UITabularView
Provides information on tabular view.
UITextBox
One-line or multi-line text box.
UITileView
Provides information on tile view.
UIView
Provides information on custom view.
UIWidget
This interface is common to all EBX® model-driven widgets.
UIWidgetFactory<T extends UIWidget>
This interface defines a factory to create a custom widget.
UIWidgetFileUpload
Widget for an upload file field.
UIWidgetFileUploadFactory
Widget factory for an upload file field.
UnavailableContentError
Unchecked exception thrown when the content of a dataset is not available, because the associated data model has errors.
UnavailableRepositoryException
Checked exception thrown when the repository is not available.
UniquenessConstraint
Defines a uniqueness constraint (property `xs:unique`) held by a table node in a data model.
UnprocessableEntityException
A runtime exception indicating that the request was understood and the syntax was correct but that the server was unable to process the contained instructions.
UploadedFile
This class represents an uploaded file.
URIBuilderForBuiltin<T extends URIBuilderForBuiltin<T>>
Provides useful methods to generate a `URI` to EBX® built-in REST services.
URIBuilderForBuiltin.ForDataAndHistory
Aggregates methods to generate built-in REST services `URI` to data and history category resources.
URIBuilderForBuiltin.ForDataset<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services `URI` to a dataset.
URIBuilderForBuiltin.ForDataspace<T extends URIBuilderForBuiltin<T>>
Beta feature: Contains methods to generate built-in REST services `URI` to a dataspace.
URIBuilderForBuiltin.ForNode<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services `URI` to a record field or a dataset node.
URIBuilderForBuiltin.ForRecord<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services `URI` to a record.
URIBuilderForBuiltin.ForTable<T extends URIBuilderForBuiltin<T>>
Contains methods to generate built-in REST services `URI` to a table.
URIBuilderForResource
This class provides useful methods to generate URI to EBX® packaged resources.
URIInfoUtility
This class provides useful methods to generate URI specific to EBX®.
URLAction
Defines an action that opens a specific URL.
URLQuery
Represents a list of URL query parameters.
UserMessage
Common abstract class for holding a text message.
UserMessageLocalized
Provides a localized message based on strings directly set from Java code (not externalized).
UserMessageRef
Holds a user message that is persisted in a Java resource bundle.
UserMessageString
Provides a message based on strings directly set from Java code (not externalized).
UserReference
Identifies a specific user.
UserService<S extends EntitySelection>
Main interface to be implemented for a user service.
UserServiceAjaxContext
This interface provides information and utility methods useful when processing an Ajax request.
UserServiceAjaxRequest
Interface that an Ajax request callback must implement.
UserServiceAjaxResponse
This interface provides methods to generate a response when processing an Ajax request.
UserServiceAssociationRecordFormContext<S extends AssociationTableEntitySelection>
This interface defines methods to get the contextual information when the user service must be created in replacement of the default record form, for an associated object to be created or accessed.
UserServiceAssociationRecordFormContext.ForCreate
This interface defines methods to get information on the current selected association and current user session.
UserServiceAssociationRecordFormContext.ForDefault
This interface defines methods to get information on the current selected association record and current user session.
UserServiceAssociationRecordFormContext.ForDuplicate
This interface defines methods to get information on the current selected association record and current user session.
UserServiceAssociationRecordFormFactory
This interface defines a factory to create a `UserService` replacing the default record form in the context of an associated object to be created or accessed.
UserServiceAssociationRecordFormFactoryContext
Provides methods for setting up a `UserServiceAssociationRecordFormFactory` in the context of its data model.
UserServiceDeclaration<S extends EntitySelection,U extends ActivationContext<S>>
This interface allows to declare a user service.
UserServiceDeclaration.OnAssociation
Declares a user service that works at an association element level.
UserServiceDeclaration.OnAssociationRecord
Declares a user service that works on a single associated record.
UserServiceDeclaration.OnDataset
Declares a user service that works at the global dataset level.
UserServiceDeclaration.OnDataspace
Declares a user service that works at the global dataspace level.
UserServiceDeclaration.OnHierarchy
Declares a user service that works at the hierarchy level.
UserServiceDeclaration.OnHierarchyNode
Declares a user service that works on a single hierarchy node.
UserServiceDeclaration.OnRecord
Declares a user service that works on a single record.
UserServiceDeclaration.OnTableView
Declares a user service that works at the table level, tabular view level and/or record selection level.
UserServiceDeclarationException
This runtime exception is thrown during a user service declaration, if it is inconsistent.
UserServiceDisplayConfigurator
This interface provides methods to set up a user service display.
UserServiceEvent
Interface that an event callback must implement.
UserServiceEventContext
This interface provides information and utility methods useful when processing an event.
UserServiceEventOutcome
An object returned by an event callback should implement this interface.
UserServiceException
This runtime exception is thrown by some methods related to user services.
UserServiceExtended<S extends EntitySelection>
Extended interface that can be implemented by a user service.
UserServiceExtensionDeclaration
Allows to extend an existing user service.
UserServiceForCreate<S extends EntitySelection>
Extended interface that can be implemented by a user service replacing a creation form.
UserServiceGetContext
This interface provides information and utility methods useful when processing a GET request.
UserServiceGetCreatedRecordContext<S extends EntitySelection>
This interface defines methods to get contextual information about the user service being invoked.
UserServiceGetRequest
Interface that a GET request callback must implement.
UserServiceGetResponse
This interface provides methods to generate a response when processing an GET request.
UserServiceInitializeContext<S extends EntitySelection>
This interface provides information and utility methods useful when initializing a user service.
UserServiceInvocationContext<S extends EntitySelection>
This interface defines methods to get contextual information about the user service being invoked.
UserServiceNext
This class provides static methods to create standard outcome values specifying what to do next.
UserServiceObjectContext
This interface provides methods to access objects registered for the user service.
UserServiceObjectContextBuilder
This interface provides methods to register or remove objects managed by the user service.
UserServiceObjectContextForInputValidation
This interface provides methods to access or update objects registered for the user service.
UserServicePane
Interface that a user service pane must implement.
UserServicePaneContext
This interface provides information and utility methods useful when defining a user service pane.
UserServicePaneWriter
This interface provides useful methods for rendering a user service pane.
UserServicePermission
Defines the permission for whether or not a user can display or execute a user service.
UserServiceProcessEventOutcomeContext<S extends EntitySelection>
This interface provides information and utility methods useful when processing an event outcome.
UserServicePropertiesDefinitionContext
Provides a context to define the common properties of a user service.
UserServiceRawPane
This interface allows to define a user service raw pane.
UserServiceRawPaneContext
This interface provides information and utility methods useful when defining a user service raw pane.
UserServiceRawPaneWriter
This interface provides useful methods for rendering a user service pane.
UserServiceRecordFormContext<S extends EntitySelection>
This interface defines methods to get contextual information when the user service must be created in replacement of the default record form.
UserServiceRecordFormContext.ForCreate
This interface defines methods to get information on the current selected table and current user session.
UserServiceRecordFormContext.ForDefault
This interface defines methods to get information on the current selected record and current user session.
UserServiceRecordFormContext.ForDuplicate
This interface defines methods to get information on the current selected record and current user session.
UserServiceRecordFormFactory
This interface defines a factory to create a `UserService` replacing the default model-driven record form.
UserServiceRecordFormFactoryContext
Provides methods that are useful when setting up a `UserServiceRecordFormFactory` in the context of a data model.
UserServiceRequest
Defines an interface to provide information about a request for a user service.
UserServiceResourceLocator
This interface defines methods to build URLs that are useful for a user service.
UserServiceRootTabbedPane
Deprecated.
From 6.0.0, `UserServiceDisplayConfigurator.newTabbedPane()` now returns a `UserServiceTabbedPane`.
UserServiceSetupDisplayContext<S extends EntitySelection>
This interface provides information and utility methods useful when setting up a user service display.
UserServiceSetupObjectContext<S extends EntitySelection>
This interface provides information and utility methods useful when defining objects managed by the user service.
UserServiceTab
A tab in a tabbed pane.
UserServiceTabbedPane
This layout divides the pane into a set of `tabs`.
UserServiceTransaction
This interface offers the possibility to mix in a single transaction and in any specified order: Record creations, Record or dataset updates, Custom procedure executions.
UserServiceTransaction.DeletedObjectOutcome
Enumeration for specifying the outcome of a transaction when the underlying data, of the object being updated, was deleted by another thread.
UserServiceTransactionManager
This class provides methods to execute transactions from a user service.
UserServiceValidateContext<S extends EntitySelection>
This interface provides information and utility methods useful when performing custom validation.
UserServiceWriter
This interface provides methods for rendering a user service content.
UserTask
If a user task requires custom behavior that cannot be specified declaratively in the workflow model, this abstract class must be extended.
UserTask.CompletionStrategy
Defines the different strategies for work items completion.
UserTask.UserTaskMode
Represents the user task mode.
UserTask.WorkItem
Defines the resulting state of a work item.
UserTask.WorkItem.State
UserTaskBeforeWorkItemCompletionContext
Dedicated context to perform checks when the user clicks the 'accept' or the 'reject' button on an interaction.
UserTaskCreationContext
This interface is used as the context for `work items creation`.
UserTaskResult
Represents a user task result.
UserTaskUsersForAllocationCollectorContext
This interface is used as the context for `UserTask.getUsersForAllocation(UserTaskUsersForAllocationCollectorContext)` to get the users list for the allocation or reallocation of a work item.
UserTaskWorkItemCompletionContext
This interface is used as the context for `work item completion`.
ValidationPolicyForTableViewEnum
Defines the different validation policy to use when displaying records in the table view.
ValidationReport
A validation report is composed of validation items, each one characterized by a severity and a user message.
ValidationReportItem
Represents an element of a validation report.
ValidationReportItemIterator
Iterator over items contained in a validation report.
ValidationReportItemSubject
Represents the subject of a validation report item.
ValidationReportItemSubjectForAdaptation
Represents the subject of a validation report item in the context of a dataset or record.
ValidationReportItemSubjectForTable
Represents the subject of a validation report item in the context of a table.
ValidationSpec
Defines the properties for validating a dataset, a table or a record.
ValidationSpec.RefreshPolicy
Defines the refresh policy for validating a dataset, a table or a record.
ValueAccessException
Thrown to indicate when an access to a value is not possible because of some inconsistencies in the data.
ValueChange
Represents a change of a terminal node value.
ValueChanges
Represents changes applied on a record.
ValueContext
Common interface for accessing the content and context of a dataset or record.
ValueContextForInputValidation
This container interface enhances the validation interface with the possibility to set values that will be automatically validated against the underlying data model.
ValueContextForUpdate
This container interface provides the possibility of setting values on persisted or transient content whose structure and types conform to an underlying data model.
ValueContextForUpdate.ValidationPolicy
Defines the policy for validating this content.
ValueContextForValidation
This container interface provides services for performing validations on nodes containing values.
ValueContextForValidationOnRecord
This interface represents a validation context for a record, in the scope of a constraint on table that performs checks at the record-level.
ValueContextForValidationOnTable
This interface provides the services for accessing the content of a table and for adding validation messages in the context of a validation process.
ValueFunction
Computes a value when this value is not persisted by EBX® repository.
ValueFunctionContext
Provides methods for setting up a value function in the context of its data model.
VersionKey
Identifies a snapshot in a repository.
WaitTaskBean
This abstract class must be extended to define a wait task bean.
WaitTaskOnResumeContext
This interface is used as the context for `resuming a wait task`.
WaitTaskOnStartContext
This interface is used as the context for `starting a wait task`.
WaitTaskResumeMessage
Represents the message given to resume a wait task.
WaitTaskResumeResult
Represents the result after resuming a wait task.
WaitTaskResumeResult.ErrorReason
Indicates the reason of a resumption failure.
WebComponentAction
Defines an action that runs a Web component.
WebComponentDeclarationContext
Provides a context to explicitly declare the HTTP parameters of a user service and to make this service available in the user interfaces used to to define a perspective action or a workflow user task.
WebComponentParameter
Specifies a parameter that can be used in the HTTP invocation of a Web component.
WidgetDisplayContext
Context of a custom widget, containing values and information about the context in which the widget is called.
WidgetFactoryContext
Context provided by the user interface to create a new instance of a custom widget.
WidgetFactorySetupContext
Provides methods for setting up a widget factory in the context of its data model.
WidgetListValidationContext
Encapsulates an HTTP request so that a custom widget can provide the user input validation context for list custom widget.
WidgetValidationContext
Encapsulates an HTTP request so that a custom widget can provide the user input validation context.
WidgetWriter
This interface offers methods that can be used to create a standard EBX® widget.
WidgetWriterForList
This interface offers methods that can be used to create a standard EBX® list widget.
WorkflowEngine
Represents the workflow engine and offers some administration functionalities.
WorkflowLauncherInfo
Represents information about a workflow launcher activation, including details about the launcher, associated documentation, and context variables.
WorkflowLauncherInfoHelper
This class provides utility methods for retrieving and processing information about available workflow launcher activations.
WorkflowPublisher
Publishes one or more workflow.
WorkflowTriggerAfterProcessInstanceStartContext
Dedicated context to handle the event "after process instance start".
WorkflowTriggerAfterWorkItemCreationContext
Dedicated context for handling the event "after work item creation".
WorkflowTriggerBean
Defines a specific workflow trigger to be called at each main event in the life cycle of a workflow instance.
WorkflowTriggerBeforeProcessInstanceTerminationContext
Dedicated context for handling the event "before process instance completion".
WorkflowTriggerBeforeWorkItemAllocationContext
Dedicated context for handling the event "before work item allocation".
WorkflowTriggerBeforeWorkItemDeallocationContext
Dedicated context for handling the event "before work item deallocation".
WorkflowTriggerBeforeWorkItemReallocationContext
Dedicated context for handling the event "before work item reallocation".
WorkflowTriggerBeforeWorkItemStartContext
Dedicated context for handling the event "before work item start".
WorkflowTriggerBeforeWorkItemTerminationContext
Dedicated context for handling the event "before work item termination".
WorkflowTriggerContext
Context for handling events related to a workflow.
WorkflowTriggerStepContext
Context for handling events related to a workflow step.
WorkflowTriggerWorkItemAllocationContext
Context for handling the event related to work item allocations.
WorkflowTriggerWorkItemAuthenticatedContext
Context for handling events related to a workflow work item in an authenticated user session.
WorkflowTriggerWorkItemContext
Context for handling events related to a workflow work item.
WorkflowView
Specifies a view in the data workflow area of the user interface.
WorkItemKey
Identifies a work item.
XPathExpressionHelper
Builds and manipulates table record XPath expressions.
XPathFilter
Defines an XPath predicate.