LogicalDeleteTimestamp (Grails Logical Delete 4.0.0)

grails.logical.delete.LogicalDeleteTimestamp

```
@groovy.transform.Trait
@groovy.transform.CompileStatic
trait LogicalDeleteTimestamp<D>
extends org.grails.datastore.gorm.GormEntity<D>
```
Adds soft delete capabilities to a domain class, recording when an entity was logically deleted in a nullable deletedAt timestamp.
An entity is considered logically deleted when deletedAt is set, and is excluded from query results by default.

Properties Summary

Properties
Type	Name and description
`java.time.Instant`	`deletedAt`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static grails.gorm.DetachedCriteria<D>`	`createCriteria()` Creates a DetachedCriteria instance, excluding soft-deleted records by default.
	`void`	`delete()` Marks the entity as logically deleted, setting `deletedAt` to the current time.
	`void`	`delete(java.util.Map params)` Marks the entity as logically deleted or physically deletes it based on the parameters.
	`static java.util.List<D>`	`findAll(java.util.Map params)` Finds all entities, excluding soft-deleted records by default.
	`static D`	`get(java.io.Serializable id)` Retrieves an entity by its identifier, excluding soft-deleted records by default.
	`static java.util.List<D>`	`list(java.util.Map params)` Lists all entities, excluding soft-deleted records by default.
	`static D`	`load(java.io.Serializable id)` Loads an entity by its identifier, excluding soft-deleted records by default.
	`static D`	`proxy(java.io.Serializable id)` Proxies an entity by its identifier, excluding soft-deleted records by default.
	`static D`	`read(java.io.Serializable id)` Reads an entity by its identifier, excluding soft-deleted records by default.
	`void`	`undelete()` Undeletes the entity by clearing `deletedAt`.
	`void`	`undelete(java.util.Map params)` Undeletes the entity by clearing `deletedAt` with additional parameters.
	`static java.lang.Object`	`withDeleted(groovy.lang.Closure closure)` Executes the given closure with soft-deleted records included in queries.

- Property Detail
  - java.time.Instant deletedAt
- Method Detail
  - static grails.gorm.DetachedCriteria<D> createCriteria()
    
    Creates a DetachedCriteria instance, excluding soft-deleted records by default.
    Returns:
    A DetachedCriteria instance
  - void delete()
    
    Marks the entity as logically deleted, setting deletedAt to the current time. An entity that is already logically deleted keeps its original deletion time.
  - void delete(java.util.Map params)
    
    Marks the entity as logically deleted or physically deletes it based on the parameters. An entity that is already logically deleted keeps its original deletion time.
    Parameters:
    params - The parameters to control saving and deletion behavior. Use 'hard: true' to physically delete the entity.
  - static java.util.List<D> findAll(java.util.Map params)
    
    Finds all entities, excluding soft-deleted records by default.
    Parameters:
    params - The query parameters
    Returns:
    A list of entity instances
  - static D get(java.io.Serializable id)
    
    Retrieves an entity by its identifier, excluding soft-deleted records by default.
    Parameters:
    id - The identifier of the entity
    Returns:
    The entity instance or null if not found
  - static java.util.List<D> list(java.util.Map params)
    
    Lists all entities, excluding soft-deleted records by default.
    Parameters:
    params - The query parameters
    Returns:
    A list of entity instances
  - static D load(java.io.Serializable id)
    
    Loads an entity by its identifier, excluding soft-deleted records by default.
    Parameters:
    id - The identifier of the entity
    Returns:
    The entity instance or null if not found
  - static D proxy(java.io.Serializable id)
    
    Proxies an entity by its identifier, excluding soft-deleted records by default.
    Parameters:
    id - The identifier of the entity
    Returns:
    The proxy instance of the entity
  - static D read(java.io.Serializable id)
    
    Reads an entity by its identifier, excluding soft-deleted records by default.
    Parameters:
    id - The identifier of the entity
    Returns:
    The entity instance or null if not found
  - void undelete()
    
    Undeletes the entity by clearing deletedAt.
  - void undelete(java.util.Map params)
    
    Undeletes the entity by clearing deletedAt with additional parameters.
    Parameters:
    params - The parameters for saving the entity.
  - static java.lang.Object withDeleted(groovy.lang.Closure closure)
    
    Executes the given closure with soft-deleted records included in queries.
    Parameters:
    closure - The closure to execute
    Returns:
    The result of the closure execution

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Trait LogicalDeleteTimestamp<D>

Properties Summary

Methods Summary

Property Detail

java.time.Instant deletedAt

Method Detail

static grails.gorm.DetachedCriteria<D> createCriteria()

void delete()

void delete(java.util.Map params)

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

static D get(java.io.Serializable id)

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

static D load(java.io.Serializable id)

static D proxy(java.io.Serializable id)

static D read(java.io.Serializable id)

void undelete()

void undelete(java.util.Map params)

static java.lang.Object withDeleted(groovy.lang.Closure closure)