📄 DockEditViewModel.cs Documentation

Assembly: IrbyImaging.UI
Namespace: IrbyImaging.Models
Author: kvamshi
Created: 03-31-2022
Last Modified: 03-31-2022


📑 Table of Contents

  1. 📝 Overview & Purpose
  2. ⚙️ Dependencies & Technologies
  3. 🚀 Key Functional Areas
  4. 🔗 Inheritance & Class Diagram (UML)
  5. 📦 ViewModel & Data Model
  6. 🛠️ Usage & Examples
  7. ✨ Extending DockEditViewModel
  8. ❗ Error Handling & Return Types
  9. 📡 API Endpoints Overview
  10. 🔧 Helper Methods & Utilities
  11. 🧩 Third‑party Integrations
  12. 🎯 Conclusion

📝 Overview & Purpose

DockEditViewModel is a marker or specialized view-model class designed to support the edit view in an MVC or MVVM pattern for a “Dock” entity in the IrbyImaging application.

  • It inherits all common editing properties (like Id, CreatedDate, ModifiedDate, etc.) from the base class EditViewModel.
  • Acts as a strongly‑typed container to pass data between controller and view during Create/Edit operations of a Dock.

Key Benefits

  • Separation of Concerns: Keeps UI‐specific fields separate from domain entities.
  • Consistency: Reuses common editing metadata in EditViewModel.
  • Extensibility: You can later add Dock‑specific edit properties without altering shared logic.

⚙️ Dependencies & Technologies

Item Description
Platform .NET (Core / Framework)
Language C#
Pattern MVVM / MVC (ViewModels)
Project Assembly IrbyImaging.UI
Base Class Provided By IrbyImaging.Models.EditViewModel
Third‑Party Libraries — (none in this file)

🚀 Key Functional Areas

  • Inheritance:
    Inherits all properties/methods from EditViewModel.
  • Marker Class:
    No additional members—serves as a semantic type for Dock‑specific editing.
  • Scaffold Hook:
    Used by code generation tools or scaffolding to detect “Dock” editing screens.

🔗 Inheritance & Class Diagram (UML)

classDiagram
    class EditViewModel {
        <<abstract>>
        +int Id
        +bool IsActive
        +DateTime CreatedOn
        +DateTime? ModifiedOn
        +void Validate()
        +Dictionary<string,string> Errors
    }
    class DockEditViewModel {
        <<concrete>>
        // no additional members
    }
    EditViewModel <|-- DockEditViewModel
  • EditViewModel: Defines core edit‑page properties & validation.
  • DockEditViewModel: Specializes or tags EditViewModel for Dock entities.

📦 ViewModel & Data Model

Class Description
EditViewModel Base class: common editing props & validation logic.
DockEditViewModel Derived class: specific to Dock edit screens.
Dock (Domain Model) Underlying entity (e.g., has Name, Location).

🛠️ Usage & Examples

1. Controller Example

using IrbyImaging.Models;
using IrbyImaging.Services;

public class DockController : Controller
{
    private readonly IDockService _dockService;
    private readonly IMapper _mapper;

    public DockController(IDockService dockService, IMapper mapper)
    {
        _dockService = dockService;
        _mapper = mapper;
    }

    // GET: /Dock/Edit/5
    public IActionResult Edit(int id)
    {
        var dockEntity = _dockService.GetById(id);
        if (dockEntity == null)
            return NotFound();

        // Map domain to view model
        var viewModel = _mapper.Map<DockEditViewModel>(dockEntity);
        return View(viewModel);
    }

    // POST: /Dock/Edit
    [HttpPost]
    public IActionResult Edit(DockEditViewModel model)
    {
        if (!ModelState.IsValid)
            return View(model);

        var domain = _mapper.Map<Dock>(model);
        _dockService.Update(domain);
        return RedirectToAction("Index");
    }
}

2. Razor View Example

@model IrbyImaging.Models.DockEditViewModel
@{
    ViewBag.Title = "Edit Dock";
}

<h2>Edit Dock 🚢</h2>

<form asp-action="Edit" method="post">
    @* Common EditViewModel fields *@
    <input type="hidden" asp-for="Id" />

    @* Dock-specific fields (if added later) *@
    <div class="form-group">
        <label asp-for="DockName"></label>
        <input asp-for="DockName" class="form-control" />
        <span asp-validation-for="DockName" class="text-danger"></span>
    </div>

    <button type="submit" class="btn btn-primary">Save</button>
</form>

✨ Extending DockEditViewModel

To add Dock‑specific properties:

public class DockEditViewModel : EditViewModel
{
    /// <summary>
    /// Name of the dock location.
    /// </summary>
    [Required]
    [StringLength(100)]
    public string DockName { get; set; }

    /// <summary>
    /// Capacity in tons.
    /// </summary>
    [Range(0, 10000)]
    public int Capacity { get; set; }
}
  • Attributes like [Required], [StringLength], [Range] enable server‑side & client‑side validation.
  • Custom validation can be implemented by overriding Validate() in EditViewModel.

❗ Error Handling & Return Types

  • Validation Errors:
    • Handled by ModelState.IsValid in controllers.
    • Error messages surfaced via <span asp-validation-for>.
  • NotFound / BadRequest:
    • If the id is invalid, return NotFound() or BadRequest().
  • Redirect:
    • On success, redirect to list or details view.

📡 API Endpoints Overview

Even though DockEditViewModel is designed for MVC views, the same model can be used in a Web API scenario:

[ApiController]
[Route("api/[controller]")]
public class DockApiController : ControllerBase
{
    [HttpPost("edit")]
    public IActionResult Edit([FromBody] DockEditViewModel model)
    {
        if (!ModelState.IsValid)
            return BadRequest(ModelState);

        // ...update logic...
        return Ok(new { success = true });
    }
}

🔧 Helper Methods & Utilities

  • Mapping: Leverage AutoMapper profiles to map between Dock and DockEditViewModel.
  • Validation: Inherit or override Validate() from EditViewModel.
  • Error Dictionary: Base class often holds a Dictionary<string, string> to collect errors.

🧩 Third‑party Integrations

  • AutoMapper: For POCO ←→ ViewModel mapping
  • FluentValidation (optional): Can be plugged‑in instead of Data Annotations
  • jQuery Validation: Client‑side validation support via tag‑helpers

🎯 Conclusion

DockEditViewModel is a lightweight, extensible, and semantic view-model that centralizes all editing metadata for “Dock” entities within the IrbyImaging application. By inheriting from EditViewModel, it promotes code reuse, clean separation of concerns, and consistent validation patterns across all edit screens.

Feel free to extend it with domain‑specific properties, validation rules, and mapping configurations to fully meet your UI requirements. 🚀