Jellyfin.Data/Entities/Libraries/PersonRole.cs


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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

#pragma warning disable CA2227

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using Jellyfin.Data.Enums;
using Jellyfin.Data.Interfaces;

namespace Jellyfin.Data.Entities.Libraries
{
    /// <summary>
    /// An entity representing a person's role in media.
    /// </summary>
    public class PersonRole : IHasArtwork, IHasConcurrencyToken
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="PersonRole"/> class.
        /// </summary>
        /// <param name="type">The role type.</param>
        /// <param name="itemMetadata">The metadata.</param>
        public PersonRole(PersonRoleType type, ItemMetadata itemMetadata)
        {
            Type = type;

            if (itemMetadata == null)
            {
                throw new ArgumentNullException(nameof(itemMetadata));
            }

            itemMetadata.PersonRoles.Add(this);

            Sources = new HashSet<MetadataProviderId>();
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PersonRole"/> class.
        /// </summary>
        /// <remarks>
        /// Default constructor. Protected due to required properties, but present because EF needs it.
        /// </remarks>
        protected PersonRole()
        {
        }

        /// <summary>
        /// Gets or sets the id.
        /// </summary>
        /// <remarks>
        /// Identity, Indexed, Required.
        /// </remarks>
        [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public int Id { get; protected set; }

        /// <summary>
        /// Gets or sets the name of the person's role.
        /// </summary>
        /// <remarks>
        /// Max length = 1024.
        /// </remarks>
        [MaxLength(1024)]
        [StringLength(1024)]
        public string Role { get; set; }

        /// <summary>
        /// Gets or sets the person's role type.
        /// </summary>
        /// <remarks>
        /// Required.
        /// </remarks>
        public PersonRoleType Type { get; set; }

        /// <inheritdoc />
        [ConcurrencyCheck]
        public uint RowVersion { get; protected set; }

        /// <summary>
        /// Gets or sets the person.
        /// </summary>
        /// <remarks>
        /// Required.
        /// </remarks>
        [Required]
        public virtual Person Person { get; set; }

        /// <inheritdoc />
        public virtual ICollection<Artwork> Artwork { get; protected set; }

        /// <summary>
        /// Gets or sets a collection containing the metadata sources for this person role.
        /// </summary>
        public virtual ICollection<MetadataProviderId> Sources { get; protected set; }

        /// <inheritdoc />
        public void OnSavingChanges()
        {
            RowVersion++;
        }
    }
}