RCommon.Models 2.3.2-alpha.0.1

RCommon.Models

Shared model interfaces and base types for the RCommon framework, providing CQRS command and query contracts, event marker interfaces for sync/async dispatch, pagination models, and execution result types for conveying operation outcomes.

Features

• ICommand and ICommand<TResult> marker interfaces for CQRS command segregation
• IQuery and IQuery<TResult> marker interfaces for CQRS query segregation
• ISerializableEvent, ISyncEvent, and IAsyncEvent marker interfaces for controlling event dispatch behavior
• CommandResult<TExecutionResult> record for wrapping command handler outcomes
• ExecutionResult with static factory methods for Success() and Failed(errors) using cached singletons
• PaginatedListModel<TSource> and PaginatedListModel<TSource, TOut> abstract records for building paginated DTOs with built-in page calculation
• PaginatedListRequest and SearchPaginatedListRequest for encapsulating paging, sorting, and search parameters
• SortDirectionEnum for specifying ascending, descending, or no-sort ordering
• All models are decorated with DataContract/DataMember attributes for serialization support

Installation

dotnet add package RCommon.Models

Usage

using RCommon.Models.Commands;
using RCommon.Models.Queries;
using RCommon.Models.Events;
using RCommon.Models.ExecutionResults;

// Define a command
public class CreateOrderCommand : ICommand<IExecutionResult>
{
    public string ProductName { get; set; }
    public int Quantity { get; set; }
}

// Define an event for async dispatch
public class OrderCreatedEvent : IAsyncEvent
{
    public Guid OrderId { get; set; }
}

// Return execution results from handlers
IExecutionResult result = ExecutionResult.Success();
IExecutionResult failure = ExecutionResult.Failed("Insufficient inventory", "Payment declined");

// Use paginated requests
var request = new SearchPaginatedListRequest
{
    PageNumber = 1,
    PageSize = 25,
    SortBy = "CreatedDate",
    SortDirection = SortDirectionEnum.Descending,
    SearchString = "widget"
};

Key Types

Documentation

For full documentation, visit rcommon.com.

Related Packages

• RCommon.Core - Foundation package with event bus, builder pattern, guards, and extensions
• RCommon.Entities - Domain entity base classes with auditing and transactional event tracking

License

Licensed under the Apache License, Version 2.0.