OnTopic-Editor-AspNetCore/OnTopic.Editor.AspNetCore/Models/EditorViewModel.cs at master · OnTopicCMS/OnTopic-Editor-AspNetCore · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*==============================================================================================================================
| Author        Ignia, LLC
| Client        Ignia, LLC
| Project       Topics Library
\=============================================================================================================================*/

namespace OnTopic.Editor.AspNetCore.Models {

  /*============================================================================================================================
  | CLASS: EDITOR VIEW MODEL
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <summary>
  ///   Represents a model for interacting with the editor interface.
  /// </summary>
  public record EditorViewModel {

    /*==========================================================================================================================
    | TOPIC
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   The <see cref="EditingTopicViewModel"/> representing the core properties of the currently selected <see
    ///   cref="Topic"/>.
    /// </summary>
    public EditingTopicViewModel Topic { get; init; } = default!;

    /*==========================================================================================================================
    | CONTENT TYPE DESCRIPTOR
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   The <see cref="ContentTypeDescriptorViewModel"/> representing the core properties of the <see cref="Topic"/>'s <see
    ///   cref="ContentTypeDescriptor"/>.
    /// </summary>
    public ContentTypeDescriptorViewModel ContentTypeDescriptor { get; init; } = default!;

    /*==========================================================================================================================
    | IS MODAL?
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Determines whether or not the page should be rendered as a modal (e.g., including the chrome or not).
    /// </summary>
    public bool IsModal { get; init; }

    /*==========================================================================================================================
    | IS NEW?
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Determines whether or not the page is being newly created.
    /// </summary>
    public bool IsNew { get; init; }

    /*==========================================================================================================================
    | IS FULLY LOADED?
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Determines if the <see cref="Topic.References"/> and <see cref="Topic.Relationships"/> are both <c>IsFullyLoaded</c>.
    ///   If not, a warning should be presented.
    /// </summary>
    public bool IsFullyLoaded { get; init; } = true;

  } // Class
} // Namespace