GormEntity (GORM for MongoDB

org.grails.datastore.gorm.GormEntity

All Implemented Interfaces and Traits:

DirtyCheckable, GormEntityApi<D>, GormValidateable
```
@groovy.transform.Trait
@groovy.transform.CompileStatic
trait GormEntity<D>
extends java.lang.Object
implements DirtyCheckable, GormEntityApi<D>, GormValidateable
```
A trait that turns any class into a GORM entity
Authors:
Jeff Brown
Graeme Rocher
Since:
4.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`D`	`addTo(java.lang.String associationName, java.lang.Object arg)` Adds the given value to given association ensuring both sides are correctly associated
	`D`	`attach()` Attaches an instance to an existing session.
	`static java.lang.Integer`	`count()` Counts the number of persisted entities
	`static D`	`create()` Creates an instance of this class
	`static BuildableCriteria`	`createCriteria()` Creates a criteria builder instance
	`private GormInstanceApi<D>`	`currentGormInstanceApi()`
	`private static GormStaticApi<D>`	`currentGormStaticApi()`
	`void`	`delete()` Deletes an instance from the datastore
	`void`	`delete(java.util.Map params)` Deletes an instance from the datastore
	`static void`	`deleteAll(java.lang.Object[] objectsToDelete)` Deletes a list of objects in one go
	`static void`	`deleteAll(java.util.Map params, java.lang.Object[] objectsToDelete)` Deletes a list of objects in one go and flushes when param is set
	`static void`	`deleteAll(java.lang.Iterable objectToDelete)` Deletes a list of objects in one go
	`static void`	`deleteAll(java.util.Map params, java.lang.Iterable objectToDelete)` Deletes a list of objects in one go and flushes when param is set
	`void`	`discard()` Discards any pending changes.
	`static java.util.List`	`executeQuery(java.lang.CharSequence query)` Executes a query for the given String
	`static java.util.List`	`executeQuery(java.lang.CharSequence query, java.util.Map args)` Executes a query for the given String
	`static java.util.List`	`executeQuery(java.lang.CharSequence query, java.util.Map params, java.util.Map args)` Executes a query for the given String
	`static java.util.List`	`executeQuery(java.lang.CharSequence query, java.util.Collection params)` Executes a query for the given String
	`static java.util.List`	`executeQuery(java.lang.CharSequence query, java.lang.Object[] params)` Executes a query for the given String
	`static java.util.List`	`executeQuery(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)` Executes a query for the given String
	`static java.lang.Integer`	`executeUpdate(java.lang.CharSequence query)` Executes an update for the given String
	`static java.lang.Integer`	`executeUpdate(java.lang.CharSequence query, java.util.Map args)` Executes an update for the given String
	`static java.lang.Integer`	`executeUpdate(java.lang.CharSequence query, java.util.Map params, java.util.Map args)` Executes an update for the given String
	`static java.lang.Integer`	`executeUpdate(java.lang.CharSequence query, java.util.Collection params)` Executes an update for the given String
	`static java.lang.Integer`	`executeUpdate(java.lang.CharSequence query, java.lang.Object[] params)` Executes an update for the given String
	`static java.lang.Integer`	`executeUpdate(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)` Executes an update for the given String
	`static boolean`	`exists(java.io.Serializable id)` Checks whether an entity exists
	`static D`	`find(groovy.lang.Closure callable)` Uses detached criteria to build a query and then execute it returning a list
	`static D`	`find(D example)` Finds an object by example
	`static D`	`find(D example, java.util.Map args)` Finds an object by example using the given arguments for pagination
	`static D`	`find(java.lang.CharSequence query)` Finds an object for the given string-based query
	`static D`	`find(java.lang.CharSequence query, java.util.Map params)` Finds an object for the given string-based query and named parameters
	`static D`	`find(java.lang.CharSequence query, java.util.Map params, java.util.Map args)` Finds an object for the given string-based query, named parameters and arguments
	`static D`	`find(java.lang.CharSequence query, java.util.Collection params)` Finds an object for the given string-based query and positional parameters
	`static D`	`find(java.lang.CharSequence query, java.lang.Object[] params)` Finds an object for the given string-based query and positional parameters
	`static D`	`find(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)` Finds an object for the given string-based query, positional parameters and arguments
	`static java.util.List<D>`	`findAll(groovy.lang.Closure callable)` Uses detached criteria to build a query and then execute it returning a list
	`static java.util.List<D>`	`findAll(java.util.Map args, groovy.lang.Closure callable)` Uses detached criteria to build a query and then execute it returning a list
	`static java.util.List<D>`	`findAll(java.util.Map params)` The same as list()
	`static java.util.List<D>`	`findAll(D example)` Finds an object by example
	`static java.util.List<D>`	`findAll(D example, java.util.Map args)` Finds an object by example using the given arguments for pagination
	`static java.util.List<D>`	`findAll(java.lang.CharSequence query)` Finds all objects for the given string-based query
	`static java.util.List<D>`	`findAll(java.lang.CharSequence query, java.util.Map params)` Finds all objects for the given string-based query and named parameters
	`static java.util.List<D>`	`findAll(java.lang.CharSequence query, java.util.Map params, java.util.Map args)` Finds all objects for the given string-based query, named parameters and arguments
	`static java.util.List<D>`	`findAll(java.lang.CharSequence query, java.util.Collection params)` Finds all objects for the given string-based query and positional parameters
	`static java.util.List<D>`	`findAll(java.lang.CharSequence query, java.lang.Object[] params)` Finds all objects for the given string-based query and positional parameters
	`static java.util.List<D>`	`findAll(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)` Finds all objects for the given string-based query, positional parameters and arguments
	`static java.util.List<D>`	`findAllWhere(java.util.Map queryMap)` Finds all results matching all of the given conditions.
	`static java.util.List<D>`	`findAllWhere(java.util.Map queryMap, java.util.Map args)` Finds all results matching all of the given conditions.
	`static D`	`findOrCreateWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`static D`	`findOrSaveWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`static D`	`findWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`static D`	`findWhere(java.util.Map queryMap, java.util.Map args)` Finds a single result matching all of the given conditions.
	`static D`	`first()` Finds the first object using the natural sort order
	`static D`	`first(java.lang.String propertyName)` Finds the first object sorted by propertyName
	`static D`	`first(java.util.Map queryParams)` Finds the first object.
	`static D`	`get(java.io.Serializable id)` Retrieves an object from the datastore. eg.
	`static java.util.List<D>`	`getAll(java.lang.Iterable<java.io.Serializable> ids)` Retrieve all the objects for the given identifiers
	`static java.util.List<D>`	`getAll(java.io.Serializable[] ids)` Retrieve all the objects for the given identifiers
	`static java.util.List<D>`	`getAll()` Returns: Synonym for list()
	`java.io.Serializable`	`getAssociationId(java.lang.String associationName)` Obtains the id of an association without initialising the association
	`static java.lang.Integer`	`getCount()` Same as count() but allows property-style syntax (Foo.count)
	`java.util.List`	`getDirtyPropertyNames()` Obtains a list of property names that are dirty.
	`static java.util.List<FinderMethod>`	`getGormDynamicFinders()`
	`static PersistentEntity`	`getGormPersistentEntity()` Returns: The PersistentEntity for this class
	`static GormQueryOperations<D>`	`getNamedQuery(java.lang.String queryName)` Looks up a named query
	`static GormQueryOperations<D>`	`getNamedQuery(java.lang.String queryName, java.lang.Object[] args)` Looks up a named query
	`java.lang.Object`	`getPersistentValue(java.lang.String fieldName)` Gets the original persisted value of a field.
	`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.
	`static D`	`last()` Finds the last object using the natural sort order
	`static D`	`last(java.lang.String propertyName)` Finds the last object sorted by propertyName
	`static D`	`last(java.util.Map queryParams)` Finds the last object.
	`static java.util.List<D>`	`list(java.util.Map params)` Lists objects in the datastore. eg.
	`static java.util.List<D>`	`list()` List all entities
	`static D`	`load(java.io.Serializable id)` Retrieves an object from the datastore as a proxy. eg.
	`D`	`lock()` Upgrades an existing persistence instance to a write lock
	`static D`	`lock(java.io.Serializable id)` Locks an instance for an update
	`private MappingContext`	`lookupMappingContext()`
	`D`	`merge()` Saves an object the datastore
	`D`	`merge(java.util.Map params)` Saves an object the datastore
	`static D`	`merge(D d)` Merges an instance with the current session
	`java.lang.Object`	`mutex(groovy.lang.Closure callable)` Locks the instance for updates for the scope of the passed closure
	`java.lang.Object`	`propertyMissing(java.lang.String name)` Allow access to datasource by name
	`static D`	`proxy(java.io.Serializable id)` Retrieves an object from the datastore as a proxy. eg.
	`static D`	`read(java.io.Serializable id)` Retrieves an object from the datastore. eg.
	`D`	`refresh()` Refreshes the state of the current instance
	`D`	`removeFrom(java.lang.String associationName, java.lang.Object arg)` Removes the given value to given association ensuring both sides are correctly disassociated
	`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
	`static java.util.List<java.io.Serializable>`	`saveAll(java.lang.Object[] objectsToSave)` Saves a list of objects in one go
	`static java.util.List<java.io.Serializable>`	`saveAll(java.lang.Iterable<?> objectsToSave)` Saves a list of objects in one go
	`static java.lang.Object`	`staticMethodMissing(java.lang.String methodName, java.lang.Object arg)` Handles static method missing for dynamic finders
	`static java.lang.Object`	`staticPropertyMissing(java.lang.String property)` Handles property missing, does nothing by default, sub traits to override
	`static void`	`staticPropertyMissing(java.lang.String property, java.lang.Object value)` Handles property missing, does nothing by default, sub traits to override
	`static DetachedCriteria<D>`	`where(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`static DetachedCriteria<D>`	`whereAny(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`static DetachedCriteria<D>`	`whereLazy(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`static java.lang.Object`	`withCriteria(groovy.lang.Closure callable)` Creates a criteria builder instance
	`static java.lang.Object`	`withCriteria(java.util.Map builderArgs, groovy.lang.Closure callable)` Creates a criteria builder instance
`<T>`	`static T`	`withDatastoreSession(groovy.lang.Closure<T> callable)` Same as withSession, but present for the case where withSession is overridden to use the Hibernate session
`<T>`	`static T`	`withNewSession(groovy.lang.Closure<T> callable)` Creates and binds a new session for the scope of the given closure
`<T>`	`static T`	`withNewTransaction(groovy.lang.Closure<T> callable)` Executes the closure within the context of a new transaction
`<T>`	`static T`	`withNewTransaction(java.util.Map transactionProperties, groovy.lang.Closure<T> callable)` Executes the closure within the context of a new transaction which is configured with the properties contained in transactionProperties.
`<T>`	`static T`	`withSession(groovy.lang.Closure<T> callable)` Execute a closure whose first argument is a reference to the current session.
`<T>`	`static T`	`withStatelessSession(groovy.lang.Closure<T> callable)` Creates and binds a new session for the scope of the given closure
`<T>`	`static T`	`withTransaction(groovy.lang.Closure<T> callable)` Executes the closure within the context of a transaction, creating one if none is present or joining an existing transaction if one is already present.
`<T>`	`static T`	`withTransaction(java.util.Map transactionProperties, groovy.lang.Closure<T> callable)` Executes the closure within the context of a transaction which is configured with the properties contained in transactionProperties.
`<T>`	`static T`	`withTransaction(org.springframework.transaction.TransactionDefinition definition, groovy.lang.Closure<T> callable)` Executes the closure within the context of a transaction for the given org.springframework.transaction.TransactionDefinition

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), 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()`

- Method Detail
  - D addTo(java.lang.String associationName, java.lang.Object arg)
    
    Adds the given value to given association ensuring both sides are correctly associated
    Parameters:
    associationName - The association name
    arg - The value
    Returns:
    This domain instance
  - D attach()
    
    Attaches an instance to an existing session. Requries a session-based model @return
  - static java.lang.Integer count()
    
    Counts the number of persisted entities
    Returns:
    The number of persisted entities
  - static D create()
    
    Creates an instance of this class
    Returns:
    The created instance
  - static BuildableCriteria createCriteria()
    
    Creates a criteria builder instance
  - private GormInstanceApi<D> currentGormInstanceApi()
  - private static GormStaticApi<D> currentGormStaticApi()
  - void delete()
    
    Deletes an instance from the datastore
  - void delete(java.util.Map params)
    
    Deletes an instance from the datastore
  - static void deleteAll(java.lang.Object[] objectsToDelete)
    
    Deletes a list of objects in one go
    Parameters:
    objectsToDelete - The objects to delete
  - static void deleteAll(java.util.Map params, java.lang.Object[] objectsToDelete)
    
    Deletes a list of objects in one go and flushes when param is set
    Parameters:
    objectsToDelete - The objects to delete
  - static void deleteAll(java.lang.Iterable objectToDelete)
    
    Deletes a list of objects in one go
    Parameters:
    objectsToDelete - Collection of objects to delete
  - static void deleteAll(java.util.Map params, java.lang.Iterable objectToDelete)
    
    Deletes a list of objects in one go and flushes when param is set
    Parameters:
    objectsToDelete - Collection of objects to delete
  - void discard()
    
    Discards any pending changes. Requires a session-based model.
  - static java.util.List executeQuery(java.lang.CharSequence query)
    
    Executes a query for the given String
    Parameters:
    query - The query represented by the given string
    Returns:
    A list of results
  - static java.util.List executeQuery(java.lang.CharSequence query, java.util.Map args)
    
    Executes a query for the given String
    Parameters:
    query - The query represented by the given string
    args - The arguments to the query
    Returns:
    A list of results
  - static java.util.List executeQuery(java.lang.CharSequence query, java.util.Map params, java.util.Map args)
    
    Executes a query for the given String
    Parameters:
    query - The query represented by the given string
    params - The named parameters to the query
    args - The arguments to the query
    Returns:
    A list of results
  - static java.util.List executeQuery(java.lang.CharSequence query, java.util.Collection params)
    
    Executes a query for the given String
    Parameters:
    query - The query represented by the given string
    params - The positional parameters to the query
    Returns:
    A list of results
  - static java.util.List executeQuery(java.lang.CharSequence query, java.lang.Object[] params)
    
    Executes a query for the given String
    Parameters:
    query - The query represented by the given string
    params - The positional parameters to the query
    Returns:
    A list of results
  - static java.util.List executeQuery(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)
    
    Executes a query for the given String
    Parameters:
    query - The query represented by the given string
    params - The positional parameters to the query
    args - The arguments to the query
    Returns:
    A list of results
  - static java.lang.Integer executeUpdate(java.lang.CharSequence query)
    
    Executes an update for the given String
    Parameters:
    query - The query represented by the given string
    Returns:
    The number of entities updated
  - static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Map args)
    
    Executes an update for the given String
    Parameters:
    query - The query represented by the given string
    params - The parameters to the query
    Returns:
    The number of entities updated
  - static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Map params, java.util.Map args)
    
    Executes an update for the given String
    Parameters:
    query - The query represented by the given string
    params - The parameters to the query
    args - The arguments to the query
    Returns:
    The number of entities updated
  - static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Collection params)
    
    Executes an update for the given String
    Parameters:
    query - The query represented by the given string
    params - The positional parameters to the query
    Returns:
    The number of entities updated
  - static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.lang.Object[] params)
    
    Executes an update for the given String
    Parameters:
    query - The query represented by the given string
    params - The positional parameters to the query
    Returns:
    The number of entities updated
  - static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)
    
    Executes an update for the given String
    Parameters:
    query - The query represented by the given string
    params - The positional parameters to the query
    args - The arguments to the query
    Returns:
    The number of entities updated
  - static boolean exists(java.io.Serializable id)
    
    Checks whether an entity exists
  - static D find(groovy.lang.Closure callable)
    
    Uses detached criteria to build a query and then execute it returning a list
    Parameters:
    callable - The callable
    Returns:
    A single entity
  - static D find(D example)
    
    Finds an object by example
    Parameters:
    example - The example
    Returns:
    A list of matching results
  - static D find(D example, java.util.Map args)
    
    Finds an object by example using the given arguments for pagination
    Parameters:
    example - The example
    args - The arguments
    Returns:
    A list of matching results
  - static D find(java.lang.CharSequence query)
    
    Finds an object for the given string-based query
    Parameters:
    query - The query
    Returns:
    The object
  - static D find(java.lang.CharSequence query, java.util.Map params)
    
    Finds an object for the given string-based query and named parameters
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The object
  - static D find(java.lang.CharSequence query, java.util.Map params, java.util.Map args)
    
    Finds an object for the given string-based query, named parameters and arguments
    params:
    args The arguments
    
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The object
  - static D find(java.lang.CharSequence query, java.util.Collection params)
    
    Finds an object for the given string-based query and positional parameters
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The object
  - static D find(java.lang.CharSequence query, java.lang.Object[] params)
    
    Finds an object for the given string-based query and positional parameters
    params:
    args The arguments
    
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The object
  - static D find(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)
    
    Finds an object for the given string-based query, positional parameters and arguments
    params:
    args The arguments
    
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The object
  - static java.util.List<D> findAll(groovy.lang.Closure callable)
    
    Uses detached criteria to build a query and then execute it returning a list
    Parameters:
    callable - The callable
    Returns:
    A List of entities
  - static java.util.List<D> findAll(java.util.Map args, groovy.lang.Closure callable)
    
    Uses detached criteria to build a query and then execute it returning a list
    Parameters:
    args - pagination parameters
    callable - The callable
    Returns:
    A List of entities
  - static java.util.List<D> findAll(java.util.Map params)
    
    The same as list()
    Returns:
    The list of all entities
  - static java.util.List<D> findAll(D example)
    
    Finds an object by example
    Parameters:
    example - The example
    Returns:
    A list of matching results
  - static java.util.List<D> findAll(D example, java.util.Map args)
    
    Finds an object by example using the given arguments for pagination
    Parameters:
    example - The example
    args - The arguments
    Returns:
    A list of matching results
  - static java.util.List<D> findAll(java.lang.CharSequence query)
    
    Finds all objects for the given string-based query
    Parameters:
    query - The query
    Returns:
    The object
  - static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Map params)
    
    Finds all objects for the given string-based query and named parameters
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The objects
  - static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Map params, java.util.Map args)
    
    Finds all objects for the given string-based query, named parameters and arguments
    params:
    args The arguments
    
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The objects
  - static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Collection params)
    
    Finds all objects for the given string-based query and positional parameters
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The objects
  - static java.util.List<D> findAll(java.lang.CharSequence query, java.lang.Object[] params)
    
    Finds all objects for the given string-based query and positional parameters
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The objects
  - static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)
    
    Finds all objects for the given string-based query, positional parameters and arguments
    params:
    args The arguments
    
    Parameters:
    query - The query
    params - The parameters
    Returns:
    The objects
  - static java.util.List<D> findAllWhere(java.util.Map queryMap)
    
    Finds all results matching all of the given conditions. Eg. Book.findAllWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    Returns:
    A list of results
  - static java.util.List<D> findAllWhere(java.util.Map queryMap, java.util.Map args)
    
    Finds all results matching all of the given conditions. Eg. Book.findAllWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    args - The Query arguments
    Returns:
    A list of results
  - static D findOrCreateWhere(java.util.Map queryMap)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand"). If a matching persistent entity is not found a new entity is created and returned.
    Parameters:
    queryMap - The map of conditions
    Returns:
    A single result
  - static D findOrSaveWhere(java.util.Map queryMap)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand"). If a matching persistent entity is not found a new entity is created, saved and returned.
    Parameters:
    queryMap - The map of conditions
    Returns:
    A single result
  - static D findWhere(java.util.Map queryMap)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    Returns:
    A single result
  - static D findWhere(java.util.Map queryMap, java.util.Map args)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    args - The Query arguments
    Returns:
    A single result
  - static D first()
    
    Finds the first object using the natural sort order
    Returns:
    the first object in the datastore, null if none exist
  - static D first(java.lang.String propertyName)
    
    Finds the first object sorted by propertyName
    Parameters:
    propertyName - the name of the property to sort by
    Returns:
    the first object in the datastore sorted by propertyName, null if none exist
  - static D first(java.util.Map queryParams)
    
    Finds the first object. If queryParams includes 'sort', that will dictate the sort order, otherwise natural sort order will be used. queryParams may include any of the same parameters that might be passed to the list(Map) method. This method will ignore 'order' and 'max' as those are always 'asc' and 1, respectively.
    Returns:
    the first object in the datastore, null if none exist
  - static D get(java.io.Serializable id)
    
    Retrieves an object from the datastore. eg. Book.get(1)
  - static java.util.List<D> getAll(java.lang.Iterable<java.io.Serializable> ids)
    
    Retrieve all the objects for the given identifiers
    Parameters:
    ids - The identifiers to operate against
    Returns:
    A list of identifiers
  - static java.util.List<D> getAll(java.io.Serializable[] ids)
    
    Retrieve all the objects for the given identifiers
    Parameters:
    ids - The identifiers to operate against
    Returns:
    A list of identifiers
  - static java.util.List<D> getAll()
    
    Returns:
    Synonym for list()
  - java.io.Serializable getAssociationId(java.lang.String associationName)
    
    Obtains the id of an association without initialising the association
    Parameters:
    associationName - The association name
    Returns:
    The id of the association or null if it doesn't have one
  - static java.lang.Integer getCount()
    
    Same as count() but allows property-style syntax (Foo.count)
  - @javax.persistence.Transient java.util.List getDirtyPropertyNames()
    
    Obtains a list of property names that are dirty. Note that unlike listDirtyPropertyNames() this method will inspect the persistence context (session) which may or may not contain a more accurate reflection of the initial loaded state depending on the underlying GORM implementation.
    Parameters:
    instance - The instance
    Returns:
    A list of property names that are dirty
  - static java.util.List<FinderMethod> getGormDynamicFinders()
  - static PersistentEntity getGormPersistentEntity()
    
    Returns:
    The PersistentEntity for this class
  - @java.lang.Deprecated static GormQueryOperations<D> getNamedQuery(java.lang.String queryName)
    
    Looks up a named query
    deprecated:
    Named queries are deprecated, use where queries instead
    
    Parameters:
    queryName - The name of the query
    Returns:
    The query or null
  - @java.lang.Deprecated static GormQueryOperations<D> getNamedQuery(java.lang.String queryName, java.lang.Object[] args)
    
    Looks up a named query
    deprecated:
    Named queries are deprecated, use where queries instead
    
    Parameters:
    queryName - The name of the query
    Returns:
    The query or null
  - java.lang.Object getPersistentValue(java.lang.String fieldName)
    
    Gets the original persisted value of a field. Note that unlike getOriginalValue(java.lang.String) this method will inspect the persistence context (session) which may or may not contain a more accurate reflection of the initial loaded state depending on the underlying GORM implementation.
    Parameters:
    fieldName - The field name
    Returns:
    The original persisted value
  - 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.
  - @javax.persistence.Transient boolean isAttached()
    
    No concept of session-based model so defaults to true
  - boolean isDirty(java.lang.String fieldName)
    
    Checks whether a field is dirty. Note that unlike hasChanged() this method will inspect the persistence context (session) which may or may not contain a more accurate reflection of the initial loaded state depending on the underlying GORM implementation.
    Parameters:
    instance - The instance
    fieldName - The name of the field
    Returns:
    true if the field is dirty
  - @javax.persistence.Transient boolean isDirty()
    
    Checks whether an entity is dirty. Note that unlike hasChanged() this method will inspect the persistence context (session) which may or may not contain a more accurate reflection of the initial loaded state depending on the underlying GORM implementation.
    Parameters:
    instance - The instance
    Returns:
    true if it is dirty
  - static D last()
    
    Finds the last object using the natural sort order
    Returns:
    the last object in the datastore, null if none exist
  - static D last(java.lang.String propertyName)
    
    Finds the last object sorted by propertyName
    Parameters:
    propertyName - the name of the property to sort by
    Returns:
    the last object in the datastore sorted by propertyName, null if none exist
  - static D last(java.util.Map queryParams)
    
    Finds the last object. If queryParams includes 'sort', that will dictate the sort order, otherwise natural sort order will be used. queryParams may include any of the same parameters that might be passed to the list(Map) method. This method will ignore 'order' and 'max' as those are always 'asc' and 1, respectively.
    Returns:
    the last object in the datastore, null if none exist
  - static java.util.List<D> list(java.util.Map params)
    
    Lists objects in the datastore. eg. Book.list(max:10)
    Parameters:
    params - Any parameters such as offset, max etc.
    Returns:
    A list of results
  - static java.util.List<D> list()
    
    List all entities
    Returns:
    The list of all entities
  - static D load(java.io.Serializable id)
    
    Retrieves an object from the datastore as a proxy. eg. Book.load(1)
  - D lock()
    
    Upgrades an existing persistence instance to a write lock
    Returns:
    The instance
  - static D lock(java.io.Serializable id)
    
    Locks an instance for an update
    Parameters:
    id - The identifier
    Returns:
    The instance
  - private MappingContext lookupMappingContext()
  - 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
  - static D merge(D d)
    
    Merges an instance with the current session
    Parameters:
    d - The object to merge
    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
  - @groovy.transform.CompileDynamic java.lang.Object propertyMissing(java.lang.String name)
    
    Allow access to datasource by name
    Parameters:
    instance - The instance
    name - The property name
    Returns:
    The property value
  - static D proxy(java.io.Serializable id)
    
    Retrieves an object from the datastore as a proxy. eg. Book.proxy(1)
  - static D read(java.io.Serializable id)
    
    Retrieves an object from the datastore. eg. Book.read(1) Since the datastore abstraction doesn't support dirty checking yet this just delegates to get(Serializable)
  - D refresh()
    
    Refreshes the state of the current instance
    Returns:
    The instance
  - D removeFrom(java.lang.String associationName, java.lang.Object arg)
    
    Removes the given value to given association ensuring both sides are correctly disassociated
    Parameters:
    associationName - The association name
    arg - The value
    Returns:
    This domain 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
  - static java.util.List<java.io.Serializable> saveAll(java.lang.Object[] objectsToSave)
    
    Saves a list of objects in one go
    Parameters:
    objectsToSave - The objects to save
    Returns:
    A list of object identifiers
  - static java.util.List<java.io.Serializable> saveAll(java.lang.Iterable<?> objectsToSave)
    
    Saves a list of objects in one go
    Parameters:
    objectToSave - Collection of objects to save
    Returns:
    A list of object identifiers
  - static java.lang.Object staticMethodMissing(java.lang.String methodName, java.lang.Object arg)
    
    Handles static method missing for dynamic finders
    Parameters:
    methodName - The name of the method
    arg - the argument to the method
    Returns:
    The value
  - static java.lang.Object staticPropertyMissing(java.lang.String property)
    
    Handles property missing, does nothing by default, sub traits to override
    Parameters:
    property - The property
    Returns:
    The value if an exception if the property doesn't exist
  - static void staticPropertyMissing(java.lang.String property, java.lang.Object value)
    
    Handles property missing, does nothing by default, sub traits to override
    Parameters:
    property - The property
    value - The value of the property
    Returns:
    The value if an exception if the property doesn't exist
  - static DetachedCriteria<D> where(groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance
  - static DetachedCriteria<D> whereAny(groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance
  - static DetachedCriteria<D> whereLazy(groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance that is lazily initialized
  - static java.lang.Object withCriteria(@groovy.lang.DelegatesTo(value: Criteria) groovy.lang.Closure callable)
    
    Creates a criteria builder instance
  - static java.lang.Object withCriteria(java.util.Map builderArgs, @groovy.lang.DelegatesTo(value: Criteria) groovy.lang.Closure callable)
    
    Creates a criteria builder instance
  - <T> static T withDatastoreSession(groovy.lang.Closure<T> callable)
    
    Same as withSession, but present for the case where withSession is overridden to use the Hibernate session
    Parameters:
    callable - the closure
    Returns:
    The result of the closure
  - <T> static T withNewSession(groovy.lang.Closure<T> callable)
    
    Creates and binds a new session for the scope of the given closure
  - <T> static T withNewTransaction(groovy.lang.Closure<T> callable)
    
    Executes the closure within the context of a new transaction
    Parameters:
    callable - The closure to call
    Returns:
    The result of the closure execution
    See Also:
    withTransaction(Closure)
    withTransaction(Map, Closure)
    withNewTransaction(Map, Closure)
  - <T> static T withNewTransaction(java.util.Map transactionProperties, groovy.lang.Closure<T> callable)
    
    Executes the closure within the context of a new transaction which is configured with the properties contained in transactionProperties. transactionProperties may contain any properties supported by org.springframework.transaction.support.DefaultTransactionDefinition. Note that if transactionProperties includes entries for propagationBehavior or propagationName, those values will be ignored. This method always sets the propagation level to TransactionDefinition.REQUIRES_NEW.
```
 SomeEntity.withNewTransaction([isolationLevel: TransactionDefinition.ISOLATION_REPEATABLE_READ]) {
     // ...
 }
 
```
    Parameters:
    transactionProperties - properties to configure the transaction properties
    callable - The closure to call
    Returns:
    The result of the closure execution
    See Also:
    org.springframework.transaction.support.DefaultTransactionDefinition
    withNewTransaction(Closure)
    withTransaction(Closure)
    withTransaction(Map, Closure)
  - <T> static T withSession(groovy.lang.Closure<T> callable)
    
    Execute a closure whose first argument is a reference to the current session.
    Parameters:
    callable - the closure
    Returns:
    The result of the closure
  - <T> static T withStatelessSession(groovy.lang.Closure<T> callable)
    
    Creates and binds a new session for the scope of the given closure
  - <T> static T withTransaction(groovy.lang.Closure<T> callable)
    
    Executes the closure within the context of a transaction, creating one if none is present or joining an existing transaction if one is already present.
    Parameters:
    callable - The closure to call
    Returns:
    The result of the closure execution
    See Also:
    withTransaction(Map, Closure)
    withNewTransaction(Closure)
    withNewTransaction(Map, Closure)
  - <T> static T withTransaction(java.util.Map transactionProperties, groovy.lang.Closure<T> callable)
    
    Executes the closure within the context of a transaction which is configured with the properties contained in transactionProperties. transactionProperties may contain any properties supported by org.springframework.transaction.support.DefaultTransactionDefinition.
```
 SomeEntity.withTransaction([propagationBehavior: TransactionDefinition.PROPAGATION_REQUIRES_NEW,
                             isolationLevel: TransactionDefinition.ISOLATION_REPEATABLE_READ]) {
     // ...
 }
 
```
    Parameters:
    transactionProperties - properties to configure the transaction properties
    callable - The closure to call
    Returns:
    The result of the closure execution
    See Also:
    org.springframework.transaction.support.DefaultTransactionDefinition
    withNewTransaction(Closure)
    withNewTransaction(Map, Closure)
    withTransaction(Closure)
  - <T> static T withTransaction(org.springframework.transaction.TransactionDefinition definition, groovy.lang.Closure<T> callable)
    
    Executes the closure within the context of a transaction for the given org.springframework.transaction.TransactionDefinition
    Parameters:
    callable - The closure to call
    Returns:
    The result of the closure execution

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Trait GormEntity<D>

Methods Summary

Inherited Methods Summary

Method Detail

D addTo(java.lang.String associationName, java.lang.Object arg)

D attach()

static java.lang.Integer count()

static D create()

static BuildableCriteria createCriteria()

private GormInstanceApi<D> currentGormInstanceApi()

private static GormStaticApi<D> currentGormStaticApi()

void delete()

void delete(java.util.Map params)

static void deleteAll(java.lang.Object[] objectsToDelete)

static void deleteAll(java.util.Map params, java.lang.Object[] objectsToDelete)

static void deleteAll(java.lang.Iterable objectToDelete)

static void deleteAll(java.util.Map params, java.lang.Iterable objectToDelete)

void discard()

static java.util.List executeQuery(java.lang.CharSequence query)

static java.util.List executeQuery(java.lang.CharSequence query, java.util.Map args)

static java.util.List executeQuery(java.lang.CharSequence query, java.util.Map params, java.util.Map args)

static java.util.List executeQuery(java.lang.CharSequence query, java.util.Collection params)

static java.util.List executeQuery(java.lang.CharSequence query, java.lang.Object[] params)

static java.util.List executeQuery(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)

static java.lang.Integer executeUpdate(java.lang.CharSequence query)

static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Map args)

static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Map params, java.util.Map args)

static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Collection params)

static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.lang.Object[] params)

static java.lang.Integer executeUpdate(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)

static boolean exists(java.io.Serializable id)

static D find(groovy.lang.Closure callable)

static D find(D example)

static D find(D example, java.util.Map args)

static D find(java.lang.CharSequence query)

static D find(java.lang.CharSequence query, java.util.Map params)

static D find(java.lang.CharSequence query, java.util.Map params, java.util.Map args)

static D find(java.lang.CharSequence query, java.util.Collection params)

static D find(java.lang.CharSequence query, java.lang.Object[] params)

static D find(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)

static java.util.List<D> findAll(groovy.lang.Closure callable)

static java.util.List<D> findAll(java.util.Map args, groovy.lang.Closure callable)

static java.util.List<D> findAll(java.util.Map params)

static java.util.List<D> findAll(D example)

static java.util.List<D> findAll(D example, java.util.Map args)

static java.util.List<D> findAll(java.lang.CharSequence query)

static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Map params)

static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Map params, java.util.Map args)

static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Collection params)

static java.util.List<D> findAll(java.lang.CharSequence query, java.lang.Object[] params)

static java.util.List<D> findAll(java.lang.CharSequence query, java.util.Collection params, java.util.Map args)

static java.util.List<D> findAllWhere(java.util.Map queryMap)

static java.util.List<D> findAllWhere(java.util.Map queryMap, java.util.Map args)

static D findOrCreateWhere(java.util.Map queryMap)

static D findOrSaveWhere(java.util.Map queryMap)

static D findWhere(java.util.Map queryMap)

static D findWhere(java.util.Map queryMap, java.util.Map args)

static D first()

static D first(java.lang.String propertyName)

static D first(java.util.Map queryParams)

static D get(java.io.Serializable id)

static java.util.List<D> getAll(java.lang.Iterable<java.io.Serializable> ids)

static java.util.List<D> getAll(java.io.Serializable[] ids)

static java.util.List<D> getAll()

java.io.Serializable getAssociationId(java.lang.String associationName)

static java.lang.Integer getCount()

@javax.persistence.Transient java.util.List getDirtyPropertyNames()

static java.util.List<FinderMethod> getGormDynamicFinders()

static PersistentEntity getGormPersistentEntity()

@java.lang.Deprecated static GormQueryOperations<D> getNamedQuery(java.lang.String queryName)

@java.lang.Deprecated static GormQueryOperations<D> getNamedQuery(java.lang.String queryName, java.lang.Object[] args)

java.lang.Object getPersistentValue(java.lang.String fieldName)

java.io.Serializable ident()

D insert()

D insert(java.util.Map params)

boolean instanceOf(java.lang.Class cls)

@javax.persistence.Transient boolean isAttached()

boolean isDirty(java.lang.String fieldName)

@javax.persistence.Transient boolean isDirty()

static D last()