@NonNullApi

Package io.jmix.core

Interface Summary

Interface	Description
AccessLogger	Helps to track access control restrictions of the current user.
CopyingSystemState<T>	Interface to be implemented by entities having a state which is not reflected in metadata.
DataLoadContext	Base interface for load contexts used in DataManager.
DataLoadContextQuery
DataManager	Same as UnconstrainedDataManager but performs authorization of all operations by applying registered access constraints.
DataSortingOptions	Defines sorting options of a data store.
DataStore	Interface defining methods for CRUD operations on entities.
Entity	Interface to be implemented by domain model objects with identifiers.
EntityAttributeImportExtension	An extension point for the entity import mechanism.
EntityAttributeSerializationExtension	An extension point for a mechanism to serialize and deserialize entity to JSON.
EntityAttributeVisitor	Visitor to be submitted to MetadataTools.traverseAttributes(Object, EntityAttributeVisitor).
EntityEntry
EntityEntryExtraState
EntityImportExport	Bean that is used for exporting a collection of entities and importing them.
EntityInitializer	Interface to be implemented by beans that initialize new entity instances created via Metadata.create(Class).
EntitySerialization	Class that is used for serialization and deserialization of entities to JSON.
EntityValuesProvider
FetchPlanRepository	Represents a repository of shared FetchPlan objects, accessible by names.
FetchPlanSerialization	Class that is used for serialization and deserialization of fetch plan to JSON.
FileStorage	Interface of a component to store and load files defined by file references.
FileStorageLocator	Provides access to all registered file storage beans of the application.
FileTransferService	A service for uploading and downloading files to/from FileStorages.
HasTimeZone	Provides user time zone information.
IdSerialization	Provides conversion of Id to and from the string representation.
InstanceNameProvider	Provide instance name and instance name properties.
MessageResolver	Interface to provide a caption of property, for example if the property is a dynamic attribute.
Messages	Central interface to work with localized messages.
Metadata	Central interface to provide metadata-related functionality.
MetadataExtension	Interface to provide additional properties of MetaClass, e.g.
MetadataTools.EntitiesHolder	INTERNAL
MetaPropertyPathResolver
PersistentAttributesLoadChecker
QueryStringProcessor	Interface to be implemented by beans that pre-process query text before setting it to LoadContext.Query.
Resources	Central infrastructure interface for loading resources.
TimeSource	Global time source interface.
UnconstrainedDataManager	Central interface to provide CRUD functionality for entities.

Class Summary

Class	Description
AccessConstraintsRegistry
AccessManager
BeanExclusionProcessor
CacheOperations	Used for additional cache operation like iterations over cache entries.
ClassManager	Loads classes taking into account hot-deploy feature.
ClientType
CoreConfiguration	Configuration of the core module.
CoreProperties
CoreScheduleConfiguration
DateTimeTransformations
EntityImportPlan	Use EntityImportPlanBuilder for building instances of EntityImportPlan.
EntityImportPlanBuilder	Builds EntityImportPlans.
EntityImportPlanProperty
EntityImportPlans	Factory for EntityImportPlanBuilder.
EntityReferencesNormalizer	Normalizes references between items of a collection.
EntitySet	Implementation of Set<Entity> with convenient methods for getting entities by a prototype instance or by a class and id.
EntityStates	Provides information about entities states.
EntitySystemStateSupport
EnvironmentUtils
ExtendedEntities	Encapsulates functionality for working with extended entities.
FetchPlan	Class to declare a graph of objects that must be retrieved from the database.
FetchPlanBuilder	Builds FetchPlans.
FetchPlanProperty	Defines a FetchPlan property.
FetchPlans	Factory for FetchPlanBuilder.
FileInfoResponse
FileRef	A reference pointing to a file located in FileStorage.
FileTypesHelper
FluentLoader<E>
FluentLoader.ByCondition<E>
FluentLoader.ById<E>
FluentLoader.ByIds<E>
FluentLoader.ByQuery<E>
FluentValueLoader<T>
FluentValuesLoader
Id<T>	Convenient class for methods that receive Id of an entity as a parameter.
Ids<T>	Helper class which represent a collection of Id
JmixModuleDescriptor	Describes a Jmix module which the current application depends on.
JmixModules	Holds the list of JmixModuleDescriptors.
JmixModulesAwareBeanSelector	Helps to select a bean that belongs to the lower module in the hierarchy of @JmixModule dependencies (where core is on top and an application is at bottom).
JmixModulesProcessor
JmixOrder	Defines constants for higher and lower precedence for Ordered or annotated with Order beans of the Jmix modules.
KeyValueMapper
LoadContext<E>	Class that defines parameters for loading entities from the database via DataManager.
LoadContext.Query	Class that defines a query to be executed for data loading.
LocaleResolver	The LocaleResolver class transforms locales to strings and vice versa to support messages localization.
MessageTools	Utility class to provide common functionality related to localized messages.
MetadataTools	Utility class to provide common metadata-related functionality.
MetadataTools.CachingEntitiesHolder	INTERNAL
QueryUtils
ReferenceToEntitySupport	Utility class to provide common functionality for entities with different type of primary keys
SaveContext	Defines collections of entities to be saved or removed, as well as parameters of saving.
Sort	Defines sorting of queries.
Sort.Order	Sort order defines a property and corresponding Sort.Direction.
Stores	Utility class for accessing registered data store names.
TemporalValue
UuidProvider	Provides static method to create UUIDs.
ValueLoadContext	Class that defines parameters for loading values from the database via UnconstrainedDataManager.loadValues(ValueLoadContext).
ValueLoadContext.Query	Class that defines a query to be executed for loading values.

Enum Summary

Enum	Description
CollectionImportPolicy	Enum describes the policy of processing collection members when importing the entity with the EntityImportPlan
DeletePolicy	This enum defines a behaviour to deal with linked objects in case of soft delete DENY - throw DeletePolicyException when linked object exists CASCADE - soft delete the linked object UNLINK - remove link
EntitySerializationOption	An object that configures how to serialize the entity to JSON.
FetchMode	Specifies how to fetch a referenced entity from the database.
FetchPlanSerializationOption	An object that configures how to serialize a fetch plan to JSON.
FileStorageException.Type
ReferenceImportBehaviour	Enum describes a behavior for references during entities import: missing reference can be ignored or an exception can be thrown.
Sort.Direction	Sort direction.

Exception Summary

Exception	Description
DeletePolicyException	Exception that is raised on attempt to soft delete an object, which has linked objects marked with OnDelete annotation with DeletePolicy.DENY value.
DevelopmentException
EntityAccessException	This exception is raised on attempt to load a deleted object.
EntityValueAccessException
FetchPlanNotFoundException	This exception is raised when you try to get nonexistent fetch plan by entity/name.
FileStorageException
FileTransferException	This exception can occur while uploading/downloading files using FileTransferService.