DomainProperty (Grails 7.0.0-SNAPSHOT)

org.grails.datastore.mapping.model.PersistentProperty

All Superinterfaces:

java.lang.Comparable<DomainProperty>, PersistentProperty
```
interface DomainProperty
extends java.lang.Comparable<DomainProperty>, PersistentProperty
```
An API to join the PersistentProperty to the org.springframework.validation.Validator to assist with scaffolding
Authors:
James Kleeh

Properties Summary

Properties
Type	Name and description
`PersistentProperty`	`rootProperty`

Methods Summary

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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface PersistentProperty`	`getCapitilizedName, getMapping, getName, getOwner, getReader, getType, getWriter, isInherited, isNullable`

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

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Interface DomainProperty

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

PersistentProperty rootProperty

Method Detail

abstract PersistentEntity getAssociatedEntity()

abstract java.lang.Class getAssociatedType()

abstract java.lang.Class getBeanType()

abstract Constrained getConstrained()

abstract java.lang.String getDefaultLabel()

abstract PersistentEntity getDomainClass()

abstract java.util.List<java.lang.String> getLabelKeys()

abstract java.lang.String getPathFromRoot()

abstract PersistentProperty getPersistentProperty()

abstract java.lang.Class getRootBeanType()

abstract PersistentProperty getRootProperty()

abstract boolean isRequired()

abstract void setRootProperty(PersistentProperty rootProperty)