Method Detail

• abstract D attach(D instance)

  Attaches an instance to an existing session. Requries a session-based model @return

• abstract void delete(D instance)

  Deletes an instance from the datastore

• abstract void delete(D instance, java.util.Map params)

  Deletes an instance from the datastore

• abstract void discard(D instance)

  Discards any pending changes. Requires a session-based model.

• abstract java.io.Serializable ident(D instance)

  Returns the objects identifier

• abstract D insert(D instance)

  Forces an insert of an object to the datastore

  Returns:

  Returns the instance

• abstract D insert(D instance, java.util.Map params)

  Forces an insert of an object to the datastore

  Returns:

  Returns the instance

• abstract boolean instanceOf(D instance, java.lang.Class cls)

  Proxy aware instanceOf implementation.

• abstract boolean isAttached(D instance)

  No concept of session-based model so defaults to true

• abstract D lock(D instance)

  Upgrades an existing persistence instance to a write lock

  Returns:

  The instance

• abstract D merge(D instance)

  Saves an object the datastore

  Returns:

  Returns the instance

• abstract D merge(D instance, java.util.Map params)

  Saves an object the datastore

  Returns:

  Returns the instance

• <T> abstract T mutex(D instance, groovy.lang.Closure<T> callable)

  Locks the given instance for updates for the scope of the passed closure.

  The lock is exclusive. A datastore that reports supportsLockedRefresh() reloads the instance's state and version under the lock, so that a competing writer is waited for and the closure runs on the committed state rather than failing on the version loaded earlier. Reloading discards unflushed changes to the instance, and requires an active transaction and an attached instance.

  Parameters:

  instance - The instance

  callable - The closure

  Returns:

  The result of the closure

• abstract java.lang.Object propertyMissing(D instance, java.lang.String name)

  Allow access to datasource by name

  Parameters:

  instance - The instance

  name - The property name

  Returns:

  The property value

• abstract D refresh(D instance)

  Refreshes the state of the current instance

  Returns:

  The instance

• @groovy.transform.CompileStatic
  D refresh(D instance, java.util.Map args)

  Refreshes the state of the given instance, with options.

  Supported arguments:

  • lock - true reloads the instance's database state and version under a pessimistic write lock; a jakarta.persistence.LockModeType reloads them under that lock mode instead. Either form acquires the lock before it reloads, discards unflushed changes, requires an attached instance and an active transaction, and holds the lock until that transaction commits or rolls back. false and jakarta.persistence.LockModeType#NONE request no lock.

  Without a requested lock this behaves like refresh(java.lang.Object). The default implementation rejects a requested lock; datastores that support it override this method.

  throws:

  RuntimeException an implementation-specific exception if a lock is requested without an active transaction, such as jakarta.persistence.TransactionRequiredException for Hibernate

  throws:

  IllegalArgumentException if a lock is requested for an instance that is not attached to the current session, or the lock argument is neither a boolean nor a lock mode

  throws:

  UnsupportedOperationException if a lock is requested and the datastore does not support it

  Parameters:

  instance - The instance

  args - The named arguments

  Returns:

  The same instance

• abstract D save(D instance)

  Saves an object the datastore

  Returns:

  Returns the instance

• abstract D save(D instance, 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

• abstract D save(D instance, java.util.Map params)

  Saves an object with the given parameters

  Parameters:

  instance - The instance

  params - The parameters

  Returns:

  The instance

• @groovy.transform.CompileStatic
  boolean supportsLockedRefresh()

  Whether refresh(java.lang.Object, java.util.Map) reloads an instance under a requested lock.

  A datastore that overrides refresh(D, Map) to honour the lock argument must report true here; one that overrides it for unrelated arguments must not, so that callers are told the lock is unavailable instead of receiving an instance that was never locked.

  Returns:

  false for the default implementation, which rejects a requested lock