Method Detail

• abstract java.lang.Integer count()

  Counts the number of persisted entities

  Returns:

  The number of persisted entities

• abstract D create()

  Creates an instance of this class

  Returns:

  The created instance

• abstract BuildableCriteria createCriteria()

  Creates a criteria builder instance

• abstract void deleteAll(java.lang.Object[] objectsToDelete)

  Deletes a list of objects in one go

  Parameters:

  objectsToDelete - The objects to delete

• abstract void deleteAll(java.lang.Iterable objectToDelete)

  Deletes a list of objects in one go

  Parameters:

  objectsToDelete - Collection of objects to delete

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

  Execute the closure for each tenant

  Parameters:

  callable - The closure

  Returns:

  The result of the closure

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

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

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

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

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

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

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

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

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

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

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

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

• abstract boolean exists(java.io.Serializable id)

  Checks whether an entity exists

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

• abstract D find(D example)

  Finds an object by example

  Parameters:

  example - The example

  Returns:

  A list of matching results

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

• abstract D find(java.lang.CharSequence query)

  Finds an object for the given string-based query

  Parameters:

  query - The query

  Returns:

  The object

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

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

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

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

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

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

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

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

  The same as list()

  Returns:

  The list of all entities

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

  The same as list()

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

  Finds an object by example

  Parameters:

  example - The example

  Returns:

  A list of matching results

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

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

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

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

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

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

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

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

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

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

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

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

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

• abstract D first()

  Finds the first object using the natural sort order

  Returns:

  the first object in the datastore, null if none exist

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

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

• abstract D get(java.io.Serializable id)

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

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

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

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

  Returns:

  Synonym for list()

• abstract java.lang.Integer getCount()

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

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

  Returns:

  The GORM dynamic finders

• abstract PersistentEntity getGormPersistentEntity()

  Returns:

  The PersistentEntity for this class

• abstract D last()

  Finds the last object using the natural sort order

  Returns:

  the last object in the datastore, null if none exist

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

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

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

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

  List all entities

  Returns:

  The list of all entities

• abstract D load(java.io.Serializable id)

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

• abstract D lock(java.io.Serializable id)

  Locks an instance for an update

  Parameters:

  id - The identifier

  Returns:

  The instance

• abstract D merge(D d)

  Merges an instance with the current session

  Parameters:

  d - The object to merge

  Returns:

  The instance

• abstract java.lang.Object methodMissing(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

• abstract java.lang.Object propertyMissing(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

• abstract void propertyMissing(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

• abstract D proxy(java.io.Serializable id)

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

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

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

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

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

  Parameters:

  callable - Callable closure containing detached criteria definition

  Returns:

  The DetachedCriteria instance

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

  Parameters:

  callable - Callable closure containing detached criteria definition

  Returns:

  The DetachedCriteria instance

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

  Parameters:

  callable - Callable closure containing detached criteria definition

  Returns:

  The DetachedCriteria instance that is lazily initialized

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

  Creates a criteria builder instance

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

  Creates a criteria builder instance

• <T> abstract 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> abstract T withNewSession(groovy.lang.Closure<T> callable)

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

• <T> abstract 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> abstract 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> abstract 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> abstract T withStatelessSession(groovy.lang.Closure<T> callable)

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

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

  Execute the closure with the given tenantId

  Parameters:

  tenantId - The tenant id

  callable - The closure

  Returns:

  The result of the closure

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

  Return the GormAllOperations for the given tenant id

  Parameters:

  tenantId - The tenant id

  Returns:

  The operations

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