66 lines
2.9 KiB
Markdown
66 lines
2.9 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.CommonCore/Events/Diagnostics/CheckDataToDownloadEvent.cs
|
||
|
|
generated_at: "2026-04-17T16:39:24.594402+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "93563fd63be87aa2"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: CheckDataToDownloadEvent.cs
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines a Prism-based event for diagnostic purposes, specifically to signal when data should be checked prior to downloading. It provides a mechanism for components to communicate about download validation, with an option to bypass the check entirely. The event carries contextual information about the producer that raised it, allowing subscribers to make informed decisions about whether to proceed with or skip validation logic.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `CheckDataToDownloadEvent`
|
||
|
|
A typed event class that inherits from `CompositePresentationEvent<CheckDataToDownloadEventArgs>`. This class has no additional members; it serves as a strongly-typed event definition for the Prism event aggregation system.
|
||
|
|
|
||
|
|
**Signature:**
|
||
|
|
```csharp
|
||
|
|
public class CheckDataToDownloadEvent : CompositePresentationEvent<CheckDataToDownloadEventArgs>
|
||
|
|
```
|
||
|
|
|
||
|
|
### `CheckDataToDownloadEventArgs`
|
||
|
|
An immutable payload class carrying event data.
|
||
|
|
|
||
|
|
**Constructor:**
|
||
|
|
```csharp
|
||
|
|
public CheckDataToDownloadEventArgs(bool bypassCheck, object o)
|
||
|
|
```
|
||
|
|
|
||
|
|
**Properties:**
|
||
|
|
| Property | Type | Access | Description |
|
||
|
|
|----------|------|--------|-------------|
|
||
|
|
| `BypassCheck` | `bool` | Public getter, private setter | Indicates whether the data check should be skipped |
|
||
|
|
| `Producer` | `object` | Public getter, private setter | Reference to the object that raised the event |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
|
||
|
|
- **Immutability**: Both `BypassCheck` and `Producer` properties are set exclusively via the constructor and cannot be modified after instantiation (private setters).
|
||
|
|
- **Nullability**: The `Producer` property accepts any `object` reference, including `null`. No null-checking is enforced by the constructor.
|
||
|
|
- **Type constraint**: The event is strongly typed to carry `CheckDataToDownloadEventArgs` via the generic base class `CompositePresentationEvent<T>`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
|
||
|
|
### This module depends on:
|
||
|
|
- `Microsoft.Practices.Prism.Events` — Provides `CompositePresentationEvent<T>`, the base class for Prism's event aggregation pattern.
|
||
|
|
|
||
|
|
### What depends on this module:
|
||
|
|
- **Unknown from source alone.** Consumers would subscribe to or publish `CheckDataToDownloadEvent` via a Prism `IEventAggregator`, but no subscribers or publishers are visible in this file.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 5. Gotchas
|
||
|
|
|
||
|
|
- **Weak type safety on `Producer`**: The `Producer` property is typed as `object`, requiring subscribers to cast if they need type-specific behavior. This design trades type safety for flexibility across heterogeneous producers.
|
||
|
|
- **No validation in constructor**: The constructor does not validate the `Producer` argument; `null` values are permitted and will propagate silently.
|
||
|
|
- **Empty event class**: `CheckDataTo
|