GormEntityApi (GORM for Hibernate 5

API for instance methods defined by a GORM entity
Authors:
Graeme Rocher
Since:
5.0.5
Parameters:
- The entity type

Methods Summary

Methods
Type Params	Return Type	Name and description
	`D`	`attach()` Attaches an instance to an existing session.
	`void`	`delete()` Deletes an instance from the datastore
	`void`	`delete(java.util.Map params)` Deletes an instance from the datastore
	`void`	`discard()` Discards any pending changes.
	`java.io.Serializable`	`ident()` Returns the objects identifier
	`D`	`insert()` Forces an insert of an object to the datastore
	`D`	`insert(java.util.Map params)` Forces an insert of an object to the datastore
	`boolean`	`instanceOf(java.lang.Class cls)` Proxy aware instanceOf implementation.
	`boolean`	`isAttached()` No concept of session-based model so defaults to true
	`boolean`	`isDirty(java.lang.String fieldName)` Checks whether a field is dirty
	`boolean`	`isDirty()` Checks whether an entity is dirty
	`D`	`lock()` Upgrades an existing persistence instance to a write lock
	`D`	`merge()` Saves an object the datastore
	`D`	`merge(java.util.Map params)` Saves an object the datastore
	`java.lang.Object`	`mutex(groovy.lang.Closure callable)` Locks the instance for updates for the scope of the passed closure
	`D`	`refresh()` Refreshes the state of the current instance
	`D`	`save()` Saves an object the datastore
	`D`	`save(boolean validate)` Save method that takes a boolean which indicates whether to perform validation or not
	`D`	`save(java.util.Map params)` Saves an object with the given parameters

- Method Detail
  - D attach()
    
    Attaches an instance to an existing session. Requries a session-based model
    Returns:
  - void delete()
    
    Deletes an instance from the datastore
  - void delete(java.util.Map params)
    
    Deletes an instance from the datastore
  - void discard()
    
    Discards any pending changes. Requires a session-based model.
  - java.io.Serializable ident()
    
    Returns the objects identifier
  - D insert()
    
    Forces an insert of an object to the datastore
    Returns:
    Returns the instance
  - D insert(java.util.Map params)
    
    Forces an insert of an object to the datastore
    Returns:
    Returns the instance
  - boolean instanceOf(java.lang.Class cls)
    
    Proxy aware instanceOf implementation.
  - boolean isAttached()
    
    No concept of session-based model so defaults to true
  - boolean isDirty(java.lang.String fieldName)
    
    Checks whether a field is dirty
    Parameters:
    instance - The instance
    fieldName - The name of the field
    Returns:
    true if the field is dirty
  - boolean isDirty()
    
    Checks whether an entity is dirty
    Parameters:
    instance - The instance
    Returns:
    true if it is dirty
  - D lock()
    
    Upgrades an existing persistence instance to a write lock
    Returns:
    The instance
  - D merge()
    
    Saves an object the datastore
    Returns:
    Returns the instance
  - D merge(java.util.Map params)
    
    Saves an object the datastore
    Returns:
    Returns the instance
  - java.lang.Object mutex(groovy.lang.Closure callable)
    
    Locks the instance for updates for the scope of the passed closure
    Parameters:
    callable - The closure
    Returns:
    The result of the closure
  - D refresh()
    
    Refreshes the state of the current instance
    Returns:
    The instance
  - D save()
    
    Saves an object the datastore
    Returns:
    Returns the instance
  - D save(boolean validate)
    
    Save method that takes a boolean which indicates whether to perform validation or not
    Parameters:
    validate - Whether to perform validation
    Returns:
    The instance or null if validation fails
  - D save(java.util.Map params)
    
    Saves an object with the given parameters
    Parameters:
    instance - The instance
    params - The parameters
    Returns:
    The instance

Summary:
Method

| Detail:
Method

[Groovy] Interface GormEntityApi<D>

Methods Summary

Method Detail

D attach()

void delete()

void delete(java.util.Map params)

void discard()

java.io.Serializable ident()

D insert()

D insert(java.util.Map params)

boolean instanceOf(java.lang.Class cls)

boolean isAttached()

boolean isDirty(java.lang.String fieldName)

boolean isDirty()

D lock()

D merge()

D merge(java.util.Map params)

java.lang.Object mutex(groovy.lang.Closure callable)

D refresh()

D save()

D save(boolean validate)

D save(java.util.Map params)