ScaffoldService (Grails 7.1.0-SNAPSHOT)

```
interface ScaffoldService<T, ID extends Serializable>
```
Scaffold service interface providing CRUD operations for domain entities.
This interface defines the complete contract for scaffold services. It is completely datastore-agnostic and can be implemented for any persistence backend: GORM (Hibernate, MongoDB, Neo4j), JPA, JDBC, REST clients, or custom implementations.

Use Cases
- Standard CRUD services with full create, read, update, delete capabilities
- Domain services that need both query and mutation operations
- Services wrapping any data access technology
- Read-only services using the readOnly flag to throw exceptions on mutations
Usage with
Scaffold:
Annotation
```
// Default GORM implementation
 @Scaffold(Car)
 class CarService {
 // AST transformation generates implementation automatically

 // Read-only service (save/delete are no-ops)
 @Scaffold(domain = Report, readOnly = true)
 class ReportService {}
 }
```
Type Parameters:
T - The entity/domain type
ID - The identifier type (Long, String, UUID, composite keys, etc.)
Authors:
Scott Murphy Heiberg
Since:
7.1.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract java.lang.Long`	`count(java.util.Map args)` Count the total number of entities matching the given criteria.
	`abstract void`	`delete(ID id)` Delete an entity by its identifier.
	`abstract T`	`get(ID id)` Retrieve a single entity by its identifier.
	`abstract java.util.List<T>`	`list(java.util.Map args)` List entities with optional pagination, sorting, and filtering.
	`abstract T`	`save(T instance)` Save (create or update) an entity.

- Method Detail
  - abstract java.lang.Long count(java.util.Map args)
    
    Count the total number of entities matching the given criteria.
    Parameters:
    args - Map containing filtering criteria
    Returns:
    Total count of matching entities
  - abstract void delete(ID id)
    
    Delete an entity by its identifier.
    Implementations should handle the case where the entity doesn't exist gracefully (either silently succeed or throw a specific exception).
    
    In readOnly mode, this operation is silently ignored (no-op).
    
    Parameters:
    id - The identifier of the entity to delete
  - abstract T get(ID id)
    
    Retrieve a single entity by its identifier.
    Parameters:
    id - The entity identifier
    Returns:
    The entity instance, or null if not found
  - abstract java.util.List<T> list(java.util.Map args)
    
    List entities with optional pagination, sorting, and filtering.
    The args map typically contains:
    - max - Maximum number of results to return
    - offset - Starting offset for pagination
    - sort - Field name to sort by
    - order - Sort order ('asc' or 'desc')
    - Additional domain-specific filter parameters
    Parameters:
    args - Map containing query parameters for pagination, sorting, and filtering
    Returns:
    List of entities matching the criteria
  - abstract T save(T instance)
    
    Save (create or update) an entity.
    Implementations should:
    - Create a new entity if it doesn't have an ID
    - Update an existing entity if it has an ID
    - Perform validation if applicable
    - Flush changes to the datastore
    throws:
    ValidationException if validation fails
    
    Parameters:
    instance - The entity instance to save
    Returns:
    The saved entity (with generated ID if new), or the original instance if readOnly mode

Summary:
Method

| Detail:
Method

[Groovy] Interface ScaffoldService<T, ID extends Serializable>

Use Cases

Usage with
Scaffold:
Annotation

Methods Summary

Method Detail

abstract java.lang.Long count(java.util.Map args)

abstract void delete(ID id)

abstract T get(ID id)

abstract java.util.List<T> list(java.util.Map args)

abstract T save(T instance)

[Groovy] Interface ScaffoldService<T, ID extends Serializable>

Use Cases

Usage withScaffold:Annotation

Methods Summary

Method Detail

abstract java.lang.Long count(java.util.Map args)

abstract void delete(ID id)

abstract T get(ID id)

abstract java.util.List<T> list(java.util.Map args)

abstract T save(T instance)

Usage with
Scaffold:
Annotation