Regira-Packages

Entity Models

Creating Entity Models

• Implement IEntity<TKey> (if entity has a serial int ID, use IEntityWithSerial))
• Have a primary key property named Id
• Implement relevant marker interfaces based on properties (see Built-in Features: Entity Interfaces)
• Be a POCO (Plain Old CLR Object) - data only, minimal behavior
• Use data annotations (MaxLength, Required, …) directly on entity properties.

public interface IEntity;
public interface IEntity<TKey> : IEntity
{
    public TKey Id { get; set; }
}

SearchObject

Use SearchObject for filtering entities.

• Created by the Controller using Model Binding from QueryString or JSON body
• Derive custom SearchObject from the SearchObject<TKey> class (or SearchObject when TKey is of type int)
• Prefer using ICollection<TKey> when filtering on key-properties for flexibility
• Timestamp filters (MinCreated, MaxCreated, MinLastModified, MaxLastModified) are interpreted as UTC; local kinds are converted, unspecified kinds are assumed UTC

public record SearchObject : SearchObject<int>;
public record SearchObject<TKey> : ISearchObject<TKey>
{
    public TKey? Id { get; set; }
    public ICollection<TKey>? Ids { get; set; }
    public ICollection<TKey>? Exclude { get; set; }
    public string? Q { get; set; }

    public DateTime? MinCreated { get; set; }
    public DateTime? MaxCreated { get; set; }
    public DateTime? MinLastModified { get; set; }
    public DateTime? MaxLastModified { get; set; }

    public ArchivedFilter? Archived { get; set; }
}

Archived Property (soft delete):

• ArchivedFilter — Excluded (archived rows invisible), Included (live + archived), Only (archived only)
• Bound from ?archived=; null falls back to DefaultArchivedFilter configured on UseEntities()
• Read by the built-in IArchivable filter only — other global filters (tenant/owner scoping) keep applying
• See: Built-in Features — Soft delete

Q Property (General Text Search):

• The Q property serves as a general text search field
• Typically used when entity implements IHasTitle or IHasDescription
• Developers can add custom filtering logic in query filters
• Use QKeywordHelper for wildcard support (*) in search queries
• See: Normalizing Entities for more info

SortBy Enum

• The default SortBy enum can be a replaced by a custom one.
• If none is configured, EntitySortBy is used.
• Sorting can be done using a collection of SortBy enum values. The enum values will be applied in the given order.
• Handled by ISortedQueryBuilder implementations

public enum EntitySortBy
{
    Default,
    Id,
    IdDesc,
    Created,
    CreatedDesc,
    LastModified,
    LastModifiedDesc,
}

Includes Enum

• Use a bitmask enum to enable multiple includes as one value.
• If none is configured, an very basic EntityIncludes is used.

[Flags]
public enum MyEntityIncludes
{
    Default = 0,
    // Add custom options here
    Option1 = 1 << 0,
    Option2 = 1 << 1,
    All = Option1 | Option2
}

Overview

1. Index — Overview of Regira Entities
2. Entity Models — Creating and structuring entity models
3. Services — Implementing entity services and repositories
4. Mapping — Mapping Entities to and from DTOs
5. Web Endpoints — Exposing entity operations as HTTP endpoints
6. Normalizing — Data normalization techniques
7. Attachments — Managing file attachments
8. Built-in Features — Ready to use components
9. Checklist — Step-by-step guide for common tasks
10. Practical Examples — Complete implementation examples

This site is open source. Improve this page.