Package io.jmix.dynmodel.meta

Record Class DynamicEntityDefinition

java.lang.Object

java.lang.Record

io.jmix.dynmodel.meta.DynamicEntityDefinition

Record Components:

name - entity name

store - physical store name

attributes - entity attributes

uniqueConstraints - entity unique constraints

views - entity-owned dynamic views

resourceRoles - entity resource-role grants

validation - entity validation definition

messages - localized entity captions

public record DynamicEntityDefinition(String name, @Nullable String store, List<DynamicAttributeDefinition> attributes, List<DynamicUniqueConstraintDefinition> uniqueConstraints, List<DynamicViewDefinition> views, @Nullable DynamicEntityAccessDefinition resourceRoles, @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation, @Nullable Map<String,String> messages)
extends Record

Defines a runtime dynamic model entity.

Constructor Summary

Constructors

Constructor	Description
DynamicEntityDefinition(String name, @Nullable String store, List<DynamicAttributeDefinition> attributes, List<DynamicUniqueConstraintDefinition> uniqueConstraints, List<DynamicViewDefinition> views, @Nullable DynamicEntityAccessDefinition resourceRoles, @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation, @Nullable Map<String,String> messages)	Creates an instance of a DynamicEntityDefinition record class.

Method Summary

Modifier and Type	Method	Description
List<DynamicAttributeDefinition>	attributes()	Returns the value of the attributes record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Map<String,String>	messages()	Returns the value of the messages record component.
String	name()	Returns the value of the name record component.
@Nullable DynamicEntityAccessDefinition	resourceRoles()	Returns the value of the resourceRoles record component.
@Nullable String	store()	Returns the value of the store record component.
final String	toString()	Returns a string representation of this record class.
List<DynamicUniqueConstraintDefinition>	uniqueConstraints()	Returns the value of the uniqueConstraints record component.
@Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition>	validation()	Returns the value of the validation record component.
List<DynamicViewDefinition>	views()	Returns the value of the views record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DynamicEntityDefinition

public DynamicEntityDefinition(String name,
 @Nullable String store,
 List<DynamicAttributeDefinition> attributes,
 List<DynamicUniqueConstraintDefinition> uniqueConstraints,
 List<DynamicViewDefinition> views,
 @Nullable DynamicEntityAccessDefinition resourceRoles,
 @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation,
 @Nullable Map<String,String> messages)

Creates an instance of a DynamicEntityDefinition record class.

Parameters:

name - the value for the name record component

store - the value for the store record component

attributes - the value for the attributes record component

uniqueConstraints - the value for the uniqueConstraints record component

views - the value for the views record component

resourceRoles - the value for the resourceRoles record component

validation - the value for the validation record component

messages - the value for the messages record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

store

public @Nullable String store()

Returns the value of the store record component.

Returns:

the value of the store record component

attributes

public List<DynamicAttributeDefinition> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component

uniqueConstraints

public List<DynamicUniqueConstraintDefinition> uniqueConstraints()

Returns the value of the uniqueConstraints record component.

Returns:

the value of the uniqueConstraints record component

views

public List<DynamicViewDefinition> views()

Returns the value of the views record component.

Returns:

the value of the views record component

resourceRoles

public @Nullable DynamicEntityAccessDefinition resourceRoles()

Returns the value of the resourceRoles record component.

Returns:

the value of the resourceRoles record component

validation

public @Nullable DynamicValidationDefinition<DynamicEntityConstraintDefinition> validation()

Returns the value of the validation record component.

Returns:

the value of the validation record component

messages

public @Nullable Map<String,String> messages()

Returns the value of the messages record component.

Returns:

the value of the messages record component