Method Detail

• java.lang.Integer count()

  Counts the number of persisted entities

  Returns:

  The number of persisted entities

• D create()

  Creates an instance of this class

  Returns:

  The created instance

• BuildableCriteria createCriteria()

  Creates a criteria builder instance

• void deleteAll(java.lang.Object... objectsToDelete)

  Deletes a list of objects in one go

  Parameters:

  objectsToDelete - The objects to delete

• void deleteAll(java.lang.Iterable objectToDelete)

  Deletes a list of objects in one go

  Parameters:

  objectsToDelete - Collection of objects to delete

• GormAllOperations<D> eachTenant(groovy.lang.Closure callable)

  Execute the closure for each tenant

  Returns:

  The result of the closure

  Parameters:

  callable - The closure

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

  Executes a query for the given String

  Returns:

  A list of results

  Parameters:

  query - The query represented by the given string

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

  Executes a query for the given String

  Returns:

  A list of results

  Parameters:

  query - The query represented by the given string

  args - The arguments to the query

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

  Executes a query for the given String

  Returns:

  A list of results

  Parameters:

  query - The query represented by the given string

  params - The named parameters to the query

  args - The arguments to the query

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

  Executes a query for the given String

  Returns:

  A list of results

  Parameters:

  query - The query represented by the given string

  params - The positional parameters to the query

• java.util.List executeQuery(java.lang.CharSequence query, java.lang.Object... params)

  Executes a query for the given String

  Returns:

  A list of results

  Parameters:

  query - The query represented by the given string

  params - The positional parameters to the query

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

  Executes a query for the given String

  Returns:

  A list of results

  Parameters:

  query - The query represented by the given string

  params - The positional parameters to the query

  args - The arguments to the query

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

  Executes an update for the given String

  Returns:

  The number of entities updated

  Parameters:

  query - The query represented by the given string

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

  Executes an update for the given String

  Returns:

  The number of entities updated

  Parameters:

  query - The query represented by the given string

  params - The parameters to the query

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

  Executes an update for the given String

  Returns:

  The number of entities updated

  Parameters:

  query - The query represented by the given string

  params - The parameters to the query

  args - The arguments to the query

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

  Executes an update for the given String

  Returns:

  The number of entities updated

  Parameters:

  query - The query represented by the given string

  params - The positional parameters to the query

• java.lang.Integer executeUpdate(java.lang.CharSequence query, java.lang.Object... params)

  Executes an update for the given String

  Returns:

  The number of entities updated

  Parameters:

  query - The query represented by the given string

  params - The positional parameters to the query

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

  Executes an update for the given String

  Returns:

  The number of entities updated

  Parameters:

  query - The query represented by the given string

  params - The positional parameters to the query

  args - The arguments to the query

• boolean exists(java.io.Serializable id)

  Checks whether an entity exists

• D find(groovy.lang.Closure callable)

  Uses detached criteria to build a query and then execute it returning a list

  Returns:

  A single entity

  Parameters:

  callable - The callable

• D find(D example)

  Finds an object by example

  Returns:

  A list of matching results

  Parameters:

  example - The example

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

  Finds an object by example using the given arguments for pagination

  Returns:

  A list of matching results

  Parameters:

  example - The example

  args - The arguments

• D find(java.lang.CharSequence query)

  Finds an object for the given string-based query

  Returns:

  The object

  Parameters:

  query - The query

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

  Finds an object for the given string-based query and named parameters

  Returns:

  The object

  Parameters:

  query - The query

  params - The parameters

• 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

  Returns:

  The object

  Parameters:

  query - The query

  params - The parameters

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

  Finds an object for the given string-based query and positional parameters

  Returns:

  The object

  Parameters:

  query - The query

  params - The parameters

• 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

  Returns:

  The object

  Parameters:

  query - The query

  params - The parameters

• 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

  Returns:

  The object

  Parameters:

  query - The query

  params - The parameters

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

  Uses detached criteria to build a query and then execute it returning a list

  Returns:

  A List of entities

  Parameters:

  callable - The callable

• 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

  Returns:

  A List of entities

  Parameters:

  args - pagination parameters

  callable - The callable

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

  The same as list()

  Returns:

  The list of all entities

• java.util.List<D> findAll()

  The same as list()

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

  Finds an object by example

  Returns:

  A list of matching results

  Parameters:

  example - The example

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

  Finds an object by example using the given arguments for pagination

  Returns:

  A list of matching results

  Parameters:

  example - The example

  args - The arguments

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

  Finds all objects for the given string-based query

  Returns:

  The object

  Parameters:

  query - The query

• 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

  Returns:

  The objects

  Parameters:

  query - The query

  params - The parameters

• 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

  Returns:

  The objects

  Parameters:

  query - The query

  params - The parameters

• 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

  Returns:

  The objects

  Parameters:

  query - The query

  params - The parameters

• 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

  Returns:

  The objects

  Parameters:

  query - The query

  params - The parameters

• 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

  Returns:

  The objects

  Parameters:

  query - The query

  params - The parameters

• 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")

  Returns:

  A list of results

  Parameters:

  queryMap - The map of conditions

• 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")

  Returns:

  A list of results

  Parameters:

  queryMap - The map of conditions

  args - The Query arguments

• 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.

  Returns:

  A single result

  Parameters:

  queryMap - The map of conditions

• 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.

  Returns:

  A single result

  Parameters:

  queryMap - The map of conditions

• 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")

  Returns:

  A single result

  Parameters:

  queryMap - The map of conditions

• 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")

  Returns:

  A single result

  Parameters:

  queryMap - The map of conditions

  args - The Query arguments

• D first()

  Finds the first object using the natural sort order

  Returns:

  the first object in the datastore, null if none exist

• D first(java.lang.String propertyName)

  Finds the first object sorted by propertyName

  Returns:

  the first object in the datastore sorted by propertyName, null if none exist

  Parameters:

  propertyName - the name of the property to sort by

• 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

• D get(java.io.Serializable id)

  Retrieves and object from the datastore. eg. Book.get(1)

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

  Retrieve all the objects for the given identifiers

  Returns:

  A list of identifiers

  Parameters:

  ids - The identifiers to operate against

• java.util.List<D> getAll(java.io.Serializable... ids)

  Retrieve all the objects for the given identifiers

  Returns:

  A list of identifiers

  Parameters:

  ids - The identifiers to operate against

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

  Returns:

  Synonym for list()

• java.lang.Integer getCount()

  Same as count() but allows property-style syntax (Foo.count)

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

  Returns:

  The GORM dynamic finders

• PersistentEntity getGormPersistentEntity()

  Returns:

  The PersistentEntity for this class

• D last()

  Finds the last object using the natural sort order

  Returns:

  the last object in the datastore, null if none exist

• D last(java.lang.String propertyName)

  Finds the last object sorted by propertyName

  Returns:

  the last object in the datastore sorted by propertyName, null if none exist

  Parameters:

  propertyName - the name of the property to sort by

• 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

• java.util.List<D> list(java.util.Map params)

  Lists objects in the datastore. eg. Book.list(max:10)

  Returns:

  A list of results

  Parameters:

  params - Any parameters such as offset, max etc.

• java.util.List<D> list()

  List all entities

  Returns:

  The list of all entities

• D load(java.io.Serializable id)

  Retrieves and object from the datastore as a proxy. eg. Book.load(1)

• D lock(java.io.Serializable id)

  Locks an instance for an update

  Returns:

  The instance

  Parameters:

  id - The identifier

• D merge(D d)

  Merges an instance with the current session

  Returns:

  The instance

  Parameters:

  d - The object to merge

• java.lang.Object methodMissing(java.lang.String methodName, java.lang.Object arg)

  Handles static method missing for dynamic finders

  Returns:

  The value

  Parameters:

  methodName - The name of the method

  arg - the argument to the method

• java.lang.Object propertyMissing(java.lang.String property)

  Handles property missing, does nothing by default, sub traits to override

  Returns:

  The value if an exception if the property doesn't exist

  Parameters:

  property - The property

• void propertyMissing(java.lang.String property, java.lang.Object value)

  Handles property missing, does nothing by default, sub traits to override

  Returns:

  The value if an exception if the property doesn't exist

  Parameters:

  property - The property

  value - The value of the property

• D proxy(java.io.Serializable id)

  Retrieves and object from the datastore as a proxy. eg. Book.proxy(1)

• D read(java.io.Serializable id)

  Retrieves and object from the datastore. eg. Book.read(1) Since the datastore abstraction doesn't support dirty checking yet this just delegates to get(Serializable)

• java.util.List<java.io.Serializable> saveAll(java.lang.Object... objectsToSave)

  Saves a list of objects in one go

  Returns:

  A list of object identifiers

  Parameters:

  objectsToSave - The objects to save

• java.util.List<java.io.Serializable> saveAll(java.lang.Iterable<?> objectsToSave)

  Saves a list of objects in one go

  Returns:

  A list of object identifiers

  Parameters:

  objectToSave - Collection of objects to save

• DetachedCriteria<D> where(groovy.lang.Closure callable)

  Returns:

  The DetachedCriteria instance

  Parameters:

  callable - Callable closure containing detached criteria definition

• DetachedCriteria<D> whereAny(groovy.lang.Closure callable)

  Returns:

  The DetachedCriteria instance

  Parameters:

  callable - Callable closure containing detached criteria definition

• DetachedCriteria<D> whereLazy(groovy.lang.Closure callable)

  Returns:

  The DetachedCriteria instance that is lazily initialized

  Parameters:

  callable - Callable closure containing detached criteria definition

• <T> T withCriteria(@groovy.lang.DelegatesTo(Criteria) groovy.lang.Closure<T> callable)

  Creates a criteria builder instance

• <T> T withCriteria(java.util.Map builderArgs, @groovy.lang.DelegatesTo(Criteria) groovy.lang.Closure callable)

  Creates a criteria builder instance

• <T> T withDatastoreSession(groovy.lang.Closure<T> callable)

  Same as withSession, but present for the case where withSession is overridden to use the Hibernate session

  Returns:

  The result of the closure

  Parameters:

  callable - the closure

• <T> T withNewSession(groovy.lang.Closure<T> callable)

  Creates and binds a new session for the scope of the given closure

• <T> T withNewTransaction(groovy.lang.Closure<T> callable)

  Executes the closure within the context of a new transaction

  Returns:

  The result of the closure execution

  Parameters:

  callable - The closure to call

  See Also:

  withTransaction(Closure)

  withTransaction(Map, Closure)

  withNewTransaction(Map, Closure)

• <T> 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]) {
       // ...
   }
   

  Returns:

  The result of the closure execution

  Parameters:

  transactionProperties - properties to configure the transaction properties

  callable - The closure to call

  See Also:

  org.springframework.transaction.support.DefaultTransactionDefinition

  withNewTransaction(Closure)

  withTransaction(Closure)

  withTransaction(Map, Closure)

• <T> T withSession(groovy.lang.Closure<T> callable)

  Execute a closure whose first argument is a reference to the current session.

  Returns:

  The result of the closure

  Parameters:

  callable - the closure

• <T> T withStatelessSession(groovy.lang.Closure<T> callable)

  Creates and binds a new session for the scope of the given closure

• <T> T withTenant(java.io.Serializable tenantId, groovy.lang.Closure<T> callable)

  Execute the closure with the given tenantId

  Returns:

  The result of the closure

  Parameters:

  tenantId - The tenant id

  callable - The closure

• GormAllOperations<D> withTenant(java.io.Serializable tenantId)

  Return the GormAllOperations for the given tenant id

  Returns:

  The operations

  Parameters:

  tenantId - The tenant id

• <T> 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.

  Returns:

  The result of the closure execution

  Parameters:

  callable - The closure to call

  See Also:

  withTransaction(Map, Closure)

  withNewTransaction(Closure)

  withNewTransaction(Map, Closure)

• <T> 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]) {
       // ...
   }
   

  Returns:

  The result of the closure execution

  Parameters:

  transactionProperties - properties to configure the transaction properties

  callable - The closure to call

  See Also:

  org.springframework.transaction.support.DefaultTransactionDefinition

  withNewTransaction(Closure)

  withNewTransaction(Map, Closure)

  withTransaction(Closure)

• <T> 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

  Returns:

  The result of the closure execution

  Parameters:

  callable - The closure to call