DK89.DomainBase 1.0.1

Example of Usage for AuditableBase and AuditableBase<TIdType>

The following examples demonstrate how to use the AuditableBase and AuditableBase<TIdType> classes in your project.

AuditableBase Example

using DK89.DomainBase.Base;
using System;

namespace MyProject.Domain
{
    /// <summary>
    /// Example entity inheriting from AuditableBase with a default GUID as ID.
    /// </summary>
    public class Product : AuditableBase
    {
        public string Name { get; set; } = default!;
        public decimal Price { get; set; }
    }
}

// Usage
var product = new Product
{
    Id = Guid.NewGuid(),
    Name = "Example Product",
    Price = 19.99M,
    CreatedBy = "Admin",
    CreatedDate = DateTime.UtcNow
};

Console.WriteLine($"Product: {product.Name}, Created By: {product.CreatedBy}, Created At: {product.CreatedDate}");

AuditableBase<TIdType> Example

using DK89.DomainBase.Base;
using System;

namespace MyProject.Domain
{
    /// <summary>
    /// Example entity inheriting from AuditableBase with a custom ID type.
    /// </summary>
    public class Order : AuditableBase<int>
    {
        public DateTime OrderDate { get; set; }
        public string CustomerName { get; set; } = default!;
    }
}

// Usage
var order = new Order
{
    Id = 1,
    OrderDate = DateTime.UtcNow,
    CustomerName = "John Doe",
    CreatedBy = "System",
    CreatedDate = DateTime.UtcNow
};

Console.WriteLine($"Order ID: {order.Id}, Customer: {order.CustomerName}, Order Date: {order.OrderDate}");

Key Features of AuditableBase and AuditableBase<TIdType>

• Auditable Fields:

  • CreatedBy: Indicates the user who created the entity.
  • CreatedDate: Timestamp of when the entity was created.
  • EditedBy: Indicates the user who last edited the entity.
  • EditedDate: Timestamp of the last edit.
  • IsDeleted: Boolean flag to indicate soft deletion.

• Customizable ID Type:

  • The default AuditableBase class uses a GUID for the Id.
  • Use AuditableBase<TIdType> to define an ID with a custom type, such as int, string, or another type.

When to Use These Classes

• Entities in a Domain Model: Use these classes as base types for entities that require auditing fields and flexible ID management.
• Soft Deletions: Handle soft deletions gracefully using the IsDeleted property.

Additional Notes

• The properties in the base classes can be overridden in derived classes as needed.
• Ensure you initialize the Id property in your derived classes, particularly when using custom ID types.