Constructor Detail

• GormStaticApi(java.lang.Class<D> persistentClass, Datastore datastore, java.util.List<FinderMethod> finders)

• GormStaticApi(java.lang.Class<D> persistentClass, Datastore datastore, java.util.List<FinderMethod> finders, org.springframework.transaction.PlatformTransactionManager transactionManager)

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

• Criteria createCriteria()

  Creates a criteria builder instance

• void deleteAll(D... objectsToDelete)

  Deletes a list of objects in one go

  Parameters:

  objectsToDelete - The objects to delete

• java.util.List<D> executeQuery(java.lang.String query)

• java.util.List<D> executeQuery(java.lang.String query, java.util.Map args)

• java.util.List<D> executeQuery(java.lang.String query, java.util.Map params, java.util.Map args)

• java.util.List<D> executeQuery(java.lang.String query, java.util.Collection params)

• java.util.List<D> executeQuery(java.lang.String query, java.util.Collection params, java.util.Map args)

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

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

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

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

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

• 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.String query)

• D find(java.lang.String query, java.util.Map args)

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

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

• D find(java.lang.String query, java.util.Collection params, java.util.Map args)

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

  The same as list()

  Returns:

  The list of all entities

• 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.String query)

• java.util.List<D> findAll(java.lang.String query, java.util.Map args)

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

• java.util.List<D> findAll(java.lang.String query, java.util.Collection params)

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

• 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 get(java.io.Serializable id)

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

• 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 FinderMethods for this class

• PersistentEntity getGormPersistentEntity()

  Returns:

  The PersistentEntity for this class

• java.util.Map<D, org.springframework.validation.Errors> getValidationErrorsMap()

  Get the thread-local map used to store Errors when validating.

  Returns:

  the map

• java.util.Map<D, java.lang.Boolean> getValidationSkipMap()

  Get the thread-local map used to store whether to skip validation.

  Returns:

  the map

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

  Method missing handler that deals with the invocation of dynamic finders

  Returns:

  The result of the method call

  Parameters:

  methodName - The method name

  args - The arguments

• 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(D... objectsToSave)

  Saves a list of objects in one go

  Returns:

  A list of object identifiers

  Parameters:

  objectsToSave - The objects to save

• void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

  Sets the org.springframework.transaction.PlatformTransactionManager to use

• void unsupported(java.lang.Object method)

• 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

• java.lang.Object withCriteria(groovy.lang.Closure callable)

  Creates a criteria builder instance

• java.lang.Object withCriteria(java.util.Map builderArgs, groovy.lang.Closure callable)

  Creates a criteria builder instance

• java.lang.Object withDatastoreSession(groovy.lang.Closure 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

• java.lang.Object withNewSession(groovy.lang.Closure callable)

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

• java.lang.Object withNewTransaction(groovy.lang.Closure callable)

  Executes the closure within the context of a new transaction

  Returns:

  The result of the closure execution

  Parameters:

  callable - The closure to call

• java.lang.Object withSession(groovy.lang.Closure callable)

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

  Returns:

  The result of the closure

  Parameters:

  callable - the closure

• java.lang.Object withTransaction(groovy.lang.Closure 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

• java.lang.Object withTransaction(org.springframework.transaction.TransactionDefinition definition, groovy.lang.Closure 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