DomainProperty (Grace Framework - 2024.0.0-SNAPSHOT)

org.grails.datastore.mapping.model.PersistentProperty

All Superinterfaces:

PersistentProperty
```
public interface DomainProperty
extends PersistentProperty, Comparable
```
An API to join the PersistentProperty to the org.springframework.validation.Validator to assist with scaffolding
Authors:
James Kleeh
Since:
2024.0.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public PersistentEntity`	`getAssociatedEntity()` Returns: The associated entity if the property is an assocation
	`public Class`	`getAssociatedType()` Returns: The type of the association
	`public Class`	`getBeanType()` Returns: The class the property belongs to
	`public Constrained`	`getConstrained()` Returns: The constraints of the property
	`public String`	`getDefaultLabel()` Returns: The default label for the property (natural name)
	`public PersistentEntity`	`getDomainClass()` Returns: The PersistentEntity the property belongs to
	`public List<String>`	`getLabelKeys()` Returns: i18n message keys to resolve the label of the property
	`public String`	`getPathFromRoot()` Returns: The path of the property from the root domain class
	`public PersistentProperty`	`getPersistentProperty()` Returns: The PersistentProperty that represents this property
	`public Class`	`getRootBeanType()` Returns: The class the root property belongs to
	`public PersistentProperty`	`getRootProperty()` Returns: The root property
	`public boolean`	`isRequired()` Returns: Whether the property is required
	`public void`	`setRootProperty(PersistentProperty rootProperty)` Sets the root property

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface Comparable`	`compareTo`

- Method Detail
  - public PersistentEntity getAssociatedEntity()
    
    Returns:
    The associated entity if the property is an assocation
  - public Class getAssociatedType()
    
    Returns:
    The type of the association
  - public Class getBeanType()
    
    Returns:
    The class the property belongs to
  - public Constrained getConstrained()
    
    Returns:
    The constraints of the property
  - public String getDefaultLabel()
    
    Returns:
    The default label for the property (natural name)
  - public PersistentEntity getDomainClass()
    
    Returns:
    The PersistentEntity the property belongs to
  - public List<String> getLabelKeys()
    
    Returns:
    i18n message keys to resolve the label of the property
  - public String getPathFromRoot()
    
    Returns:
    The path of the property from the root domain class
  - public PersistentProperty getPersistentProperty()
    
    Returns:
    The PersistentProperty that represents this property
  - public Class getRootBeanType()
    
    Returns:
    The class the root property belongs to
  - public PersistentProperty getRootProperty()
    
    Returns:
    The root property
  - public boolean isRequired()
    
    Returns:
    Whether the property is required
  - public void setRootProperty(PersistentProperty rootProperty)
    
    Sets the root property
    Parameters:
    rootProperty - The root property

Summary:
Method

| Detail:
Method

[Java] Interface DomainProperty

Methods Summary

Inherited Methods Summary

Method Detail

public PersistentEntity getAssociatedEntity()

public Class getAssociatedType()

public Class getBeanType()

public Constrained getConstrained()

public String getDefaultLabel()

public PersistentEntity getDomainClass()

public List<String> getLabelKeys()

public String getPathFromRoot()

public PersistentProperty getPersistentProperty()

public Class getRootBeanType()

public PersistentProperty getRootProperty()

public boolean isRequired()

public void setRootProperty(PersistentProperty rootProperty)