44 lines
3.5 KiB
Markdown
44 lines
3.5 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.CommonCore/Interface/ViewData/IViewDataView.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/ViewData/IViewDataViewModel.cs
|
||
|
|
generated_at: "2026-04-16T02:19:02.978313+00:00"
|
||
|
|
model: "Qwen/Qwen3-Coder-Next-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "820bab209e8d1b8f"
|
||
|
|
---
|
||
|
|
|
||
|
|
# ViewData
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
This module defines foundational interfaces for a view-layer architecture in the DTS.CommonCore library, specifically for implementing the *View Data* pattern (likely part of a broader MVVM or similar separation of concerns). The `IViewDataView` and `IViewDataViewModel` interfaces serve as marker interfaces that extend base view and view model contracts (`IBaseView`, `IBaseViewModel`), enabling type-safe binding and dependency injection of view-related components while preserving abstraction and decoupling between UI presentation and business logic layers.
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
No public *functions*, *properties*, or *methods* are defined directly in these interfaces. They are empty (marker) interfaces. Their sole purpose is to establish type identity and inheritance relationships.
|
||
|
|
|
||
|
|
- `interface IViewDataView : IBaseView`
|
||
|
|
A marker interface for views that expose or consume *view data* (e.g., data-bound UI elements). It inherits from `IBaseView`, implying it adheres to the base view contract (e.g., lifecycle, initialization, or rendering semantics defined elsewhere).
|
||
|
|
|
||
|
|
- `interface IViewDataViewModel : IBaseViewModel`
|
||
|
|
A marker interface for view models that provide *view data* (e.g., state, commands, or data structures consumed by `IViewDataView`). It inherits from `IBaseViewModel`, implying it conforms to the base view model contract (e.g., data binding support, state management, or notification patterns defined elsewhere).
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
- `IViewDataView` must be implemented by types that also satisfy `IBaseView`.
|
||
|
|
- `IViewDataViewModel` must be implemented by types that also satisfy `IBaseViewModel`.
|
||
|
|
- No additional behavioral invariants are specified beyond inheritance; the interfaces themselves impose no runtime constraints.
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
- **Depends on**:
|
||
|
|
- `DTS.Common.Base.IBaseView` (via `IViewDataView`)
|
||
|
|
- `DTS.Common.Base.IBaseViewModel` (via `IViewDataViewModel`)
|
||
|
|
- `DTS.Common.Base` namespace (implicit dependency on the `DTS.Common.Base` assembly/module)
|
||
|
|
|
||
|
|
- **Depended on by**:
|
||
|
|
- Not determinable from source alone. Likely used elsewhere in the codebase (e.g., in DI registrations, view/view model factories, or binding infrastructure) to constrain generic parameters (e.g., `TView : IViewDataView`, `TViewModel : IViewDataViewModel`) or enforce architectural rules.
|
||
|
|
|
||
|
|
## 5. Gotchas
|
||
|
|
- **Ambiguity of purpose**: The term *“View Data”* is not defined in the source. Its semantic distinction from other view/view model types (e.g., `IBaseView` vs. `IViewDataView`) is unclear without additional context (e.g., documentation or usage examples).
|
||
|
|
- **No API surface**: Since these are marker interfaces, developers may mistakenly expect methods/properties—ensure they are used only for type checking (`is`, `as`, generic constraints) or DI registration, not behavior invocation.
|
||
|
|
- **Potential naming overlap**: If other modules define similarly named interfaces (e.g., `IViewData`), confusion may arise; verify naming consistency across the codebase.
|
||
|
|
- **No versioning or deprecation hints**: No attributes (e.g., `[Obsolete]`) or version comments are present; assume stability but verify usage in consuming code for compatibility.
|
||
|
|
- **None identified from source alone.**
|