GormInstanceApi (GORM 7.3.4)

org.grails.datastore.gorm.GormInstanceApi

All Implemented Interfaces and Traits:

GormInstanceOperations
```
@groovy.transform.CompileStatic
class GormInstanceApi
extends AbstractGormApi
```
Instance methods of the GORM API.
Parameters:
- the entity/domain class
Authors:
Graeme Rocher

Inherited fields
Fields inherited from class	Fields
`class AbstractGormApi`	`persistentClass, persistentEntity`
`class AbstractDatastoreApi`	`datastore`

Properties Summary

Properties
Type	Name and description
`boolean`	`failOnError`
`boolean`	`markDirty`
`java.lang.Class<? extends java.lang.Exception>`	`validationException`

Constructor Summary

Constructors
Constructor and description
`GormInstanceApi (java.lang.Class<D> persistentClass, Datastore datastore)`

Methods Summary

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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractGormApi`	`getExtendedMethods, getMethods, initializeMethods`
`class AbstractDatastoreApi`	`execute, execute, getDatastore`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - boolean failOnError
  - boolean markDirty
  - java.lang.Class<? extends java.lang.Exception> validationException
- Constructor Detail
  - GormInstanceApi(java.lang.Class<D> persistentClass, Datastore datastore)
- Method Detail
  - D attach(D instance)
    
    Attaches an instance to an existing session. Requries a session-based model
    Returns:
    Parameters:
    instance - The instance
  - void delete(D instance)
    
    Deletes an instance from the datastore
    Parameters:
    instance - The instance to delete
  - void delete(D instance, java.util.Map params)
    
    Deletes an instance from the datastore
    Parameters:
    instance - The instance to delete
  - void discard(D instance)
    
    Discards any pending changes. Requires a session-based model.
  - protected D doSave(D instance, java.util.Map params, Session session, boolean isInsert = false)
  - java.util.List getDirtyPropertyNames(D instance)
    
    Obtains a list of property names that are dirty
    Returns:
    A list of property names that are dirty
    Parameters:
    instance - The instance
  - java.lang.Object getPersistentValue(D instance, java.lang.String fieldName)
    
    Gets the original persisted value of a field.
    Returns:
    The original persisted value
    Parameters:
    fieldName - The field name
  - java.io.Serializable ident(D instance)
    
    Returns the objects identifier
  - D insert(D instance)
    
    Forces an insert of an object to the datastore
    Returns:
    Returns the instance
    Parameters:
    instance - The instance
  - D insert(D instance, java.util.Map params)
    
    Forces an insert of an object to the datastore
    Returns:
    Returns the instance
    Parameters:
    instance - The instance
  - boolean instanceOf(D o, java.lang.Class cls)
    
    Proxy aware instanceOf implementation.
  - boolean isAttached(D instance)
    
    No concept of session-based model so defaults to true
  - boolean isDirty(D instance, java.lang.String fieldName)
    
    Checks whether a field is dirty
    Returns:
    true if the field is dirty
    Parameters:
    instance - The instance
    fieldName - The name of the field
  - boolean isDirty(D instance)
    
    Checks whether an entity is dirty
    Returns:
    true if it is dirty
    Parameters:
    instance - The instance
  - D lock(D instance)
    
    Upgrades an existing persistence instance to a write lock
    Returns:
    The instance
  - D merge(D instance)
    
    Saves an object the datastore
    Returns:
    Returns the instance
    Parameters:
    instance - The instance
  - D merge(D instance, java.util.Map params)
    
    Saves an object the datastore
    Returns:
    Returns the instance
    Parameters:
    instance - The instance
  - <T> T mutex(D instance, groovy.lang.Closure<T> callable)
    
    Locks the instance for updates for the scope of the passed closure
    Returns:
    The result of the closure
    Parameters:
    callable - The closure
  - java.lang.Object propertyMissing(D instance, java.lang.String name)
  - D refresh(D instance)
    
    Refreshes the state of the current instance
    Returns:
    The instance
    Parameters:
    instance - The instance
  - D save(D instance)
    
    Saves an object the datastore
    Returns:
    Returns the instance
    Parameters:
    instance - The instance
  - D save(D instance, boolean validate)
    
    Save method that takes a boolean which indicates whether to perform validation or not
    Returns:
    The instance or null if validation fails
    Parameters:
    instance - The instance
    validate - Whether to perform validation
  - D save(D instance, java.util.Map params)
    
    Saves an object with the given parameters
    Returns:
    The instance
    Parameters:
    instance - The instance
    params - The parameters

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class GormInstanceApi<D>

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

boolean failOnError

boolean markDirty

java.lang.Class<? extends java.lang.Exception> validationException

Constructor Detail

GormInstanceApi(java.lang.Class<D> persistentClass, Datastore datastore)

Method Detail

D attach(D instance)

void delete(D instance)

void delete(D instance, java.util.Map params)

void discard(D instance)

protected D doSave(D instance, java.util.Map params, Session session, boolean isInsert = false)

java.util.List getDirtyPropertyNames(D instance)

java.lang.Object getPersistentValue(D instance, java.lang.String fieldName)

java.io.Serializable ident(D instance)

D insert(D instance)

D insert(D instance, java.util.Map params)

boolean instanceOf(D o, java.lang.Class cls)

boolean isAttached(D instance)

boolean isDirty(D instance, java.lang.String fieldName)

boolean isDirty(D instance)

D lock(D instance)

D merge(D instance)

D merge(D instance, java.util.Map params)

<T> T mutex(D instance, groovy.lang.Closure<T> callable)

java.lang.Object propertyMissing(D instance, java.lang.String name)

D refresh(D instance)

D save(D instance)

D save(D instance, boolean validate)

D save(D instance, java.util.Map params)