Class Annotations

Defines an embedded entity stored in the same table as the owning entity.

@MetaClass annotation should be used to specify the entity name.


Indicates that the entity instances are available for recovery after soft deletion on the core$Entity.restore screen available through the Administration > Data Recovery main menu item.


Declares a class to be a data model entity.


  • name – the name of the entity, must begin with a prefix, separated by a _ sign. It is recommended to use a short name of the project as a prefix to form a separate namespace.


@Entity(name = "sales_Customer")

Indicates that the entity is an extension and it should be used everywhere instead of the base entity. See Functionality Extension.


Is used for defining a database column responsible for the distinction of entity types in the cases of SINGLE_TABLE and JOINED inheritance strategies.


  • name – the discriminator column name

  • discriminatorType – the discriminator column type


@DiscriminatorColumn(name = "TYPE", discriminatorType = DiscriminatorType.INTEGER)

Defines the discriminator column value for this entity.



Explicitly defines the name of a database sequence that should be used for generating identifiers if the entity is a subclass of BaseLongIdEntity or BaseIntegerIdEntity. If the entity is not annotated, the framework creates a sequence with an automatically generated name.


  • name – sequence name.

  • cached - optional parameter which defines that the sequence should be incremented by cuba.numberIdCacheSize to cache intermediate values in memory. False by default.


Defines the inheritance strategy to be used for an entity class hierarchy. It is specified on the entity class that is the root of the entity class hierarchy.


  • strategy – inheritance strategy, SINGLE_TABLE by default


Defines the list of listeners intended for reaction to the entity instance lifecycle events on the middle tier.

The annotation value should be a string or an array of strings containing bean names of the listeners. See Entity Listeners.



Defines that the class is an ancestor for some entities and its attributes must be used as part of descendant entities. Such class is not associated with any particular database table.


Is used for declaring non-persistent or embedded entity (meaning that @javax.persistence.Entity annotation cannot be applied)


  • name – the entity name, must begin with a prefix, separated by a _ sign. It is recommended to use a short name of the project as prefix to form a separate namespace.


@MetaClass(name = "sales_Customer")

Defines how to create a string which represents a single instance of the entity. Think of it as of an application level toString() method. It is used extensively in UI when displaying an entity instance in a single field like TextField or LookupField. You can also get the instance name programmatically using the MetadataTools.getInstanceName() method.

The annotation value should be a string in the {0}|{1} format, where:

  • {0} – format string which can be one of two types:

    • A string with %s placeholders for formatted values of entity attributes. Attribute values are formatted to strings according to their datatypes.

    • A name of this object’s method with the # prefix. The method should return String and should have no parameters.

  • {1} – a list of attribute names separated by commas, corresponding to {0} format. If a method is used in {0}, the list of fields is still required as it forms the _minimal view.


@NamePattern("%s - %s|name,date")

This annotation can be specified for a method. Such method will be invoked right after the entity instance is created by the Metadata.create() method. This is convenient when instance initialization requires invocation of managed beans. For example, see Entity Fields Initialization.


Is used in the case of JOINED inheritance strategy to specify a foreign key column for the entity which refers to the primary key of the ancestor entity.


  • name – the name of the foreign key column of the entity

  • referencedColumnName – the name of primary key column of the ancestor entity


@PrimaryKeyJoinColumn(name = "CARD_ID", referencedColumnName = "ID")

Indicates that EntityChangedEvent should be sent by the framework when the entity is changed in the database.


Indicates that the entity is system only and should not be available for selection in various lists of entities, such as generic filter parameter types or dynamic attribute type.


Defines database table for the given entity.


  • name – the table name


@Table(name = "SALES_CUSTOMER")

Indicates that editor screens opening history will be recorded with the ability to display it on the sec$ScreenHistory.browse. The screen can be added to the main menu using the following element of web-menu.xml:

<item id="sec$ScreenHistory.browse" insertAfter="settings"/>