Property Detail

• Boolean enableEvents

  default to true. If false only method events are invoked on the implemented Repository.

• Class<D> entityClass

  The java class for the Gorm domain (persistence entity). will generally get set in constructor or using the generic as done in GormRepo.getEntityClass using the GenericTypeResolver

  See Also:

  PersistentEntity.getJavaClass

• @Qualifier("entityMapBinder") @Autowired MapBinder mapBinder

• @Autowired RepoEventPublisher repoEventPublisher

• @Autowired RepoExceptionSupport repoExceptionSupport

Method Detail

• @Override void bind(Map args = [:], D entity, Map data, BindAction bindAction)

  binds by calling doBind and fires before and after events better to override doBind in implementing classes for custom binding logic. Or even better implement the beforeBind|afterBind event methods

• void bindAndSave(Map args, D entity, Map data, BindAction bindAction)

  short cut to call bind, setup args for events then calls doPersist

• void clear()

  cache clear on the datastore's currentSession. When possible use the transactionStatus. see WithTrx trait

• @Override D create(Map args = [:], Map data)

  Transactional wrap for doCreate

• @Override void doBind(Map args, D entity, Map data, BindAction bindAction)

  Main bind method that redirects call to the injected mapBinder. override this one in implementing classes. can also call this if you do NOT want the before/after Bind events to fire

• @Override D doCreate(Map args, Map data)

  Creates entity using the data from params. calls the bind with bindMethod='Create'

  Parameters:

  data - the data to bind onto the entity

  Returns:

  the created domain entity

  See Also:

  doPersist

• @Override D doPersist(Map args = [:], D entity)

  saves a domain entity with the passed in args. Not wrapped in a transaction. If a ValidationException is caught it wraps and throws it with our DataValidationException.

  throws:

  DataAccessException if a validation or DataAccessException error happens

  Parameters:

  entity - the domain entity to call save on

  args - (optional) - the arguments to pass to save as well as the PersistEvents. can be any of the normal gorm save args plus some others specific to here - failOnError: (boolean) defaults to true - flush: (boolean) flush the session - bindType: (String) "Create" or "Update" when coming from those actions/methods - data: (Map) if it was a Create or Update method called then this is the data and gets passed into events

• void doRemove(Map args = [:], D entity)

  no trx wrapper. delete entity.

  Parameters:

  entity - - the domain instance to delete

  args - - args passed to delete

• @Override D doUpdate(Map args, Map data)

  Updates entity using the data from params. calls the bind with bindMethod='Update'

  Parameters:

  data - the data to bind onto the entity

  Returns:

  the updated domain entity

  See Also:

  doPersist

• void flush()

  flush on the datastore's currentSession. When possible use the transactionStatus.flush(). see WithTrx trait

• @Override D get(Serializable id, Long version)

  gets and verifies that the entity can be retrieved and version matches.

  throws:

  EntityNotFoundException if its not found

  throws:

  gorm.tools.repository.errors.EntityValidationException if the versions mismatch

  Parameters:

  id - required, the id to get

  version - - can be null. if its passed in then it validates its that same as the version in the retrieved entity.

  Returns:

  the retrieved entity. Will always be an entity as this throws an error if not

• @Override D get(Map params)

  This default will redirect the call to get(Serializable id, Long version). Implementing classes can override this and add custom finders using another unique lookup key other than id, such as customer number or invoice number. Unlike the normal get(id) This throws a EntityNotFoundException if nothing is found instead of returning a null.

  Parameters:

  params - - expects a Map with an id key and optionally a version, implementation classes can customize to work with more.

  Returns:

  the entity. Won't return null, instead it throws an exception

• Datastore getDatastore()

  gets the datastore for this Gorm domain instance

• @Override Class<D> getEntityClass()

  The gorm domain class. uses the GenericTypeResolver is not set during contruction

• GormInstanceApi<D> getInstanceApi()

• GormStaticApi<D> getStaticApi()

• @Override RuntimeException handleException(RuntimeException ex, D entity)

• @Override D persist(Map args = [:], D entity)

  Transactional wrap for doPersist Saves a domain entity with the passed in args and rewraps ValidationException with EntityValidationException on error.

  throws:

  DataAccessException if a validation or DataAccessException error happens

  Parameters:

  entity - the domain entity to call save on

  args - the arguments to pass to save. adds the following but see doPersist for more. - tx: defaults to true. set to true to make sure this is wrapped in a transaction.

• @Override void remove(Map args = [:], D entity)

  Transactional, Calls delete always with flush = true so we can intercept any DataIntegrityViolationExceptions.

  throws:

  EntityValidationException if a spring DataIntegrityViolationException is thrown

  Parameters:

  entity - the domain entity

• @Override void removeById(Map args = [:], Serializable id)

  Remove by ID

  throws:

  EntityNotFoundException if its not found or if a DataIntegrityViolationException is thrown

  Parameters:

  id - - the id to delete

  args - - the args to pass to delete. flush being the most common

• @Override D update(Map args = [:], Map data)

  Transactional wrap for doUpdate

• <T> T withTrx(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:

  GormStaticApi.withTransaction

  GormStaticApi.withNewTransaction

  GormStaticApi.withNewTransaction