aboutsummaryrefslogtreecommitdiffstats
path: root/ctrack/caf/models.py
blob: c290ee39c6c9f37e6418f6404e8e55de688511a3 (plain) (blame)
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
from django.db import models

from ctrack.organisations.models import Organisation, Person


class Grading(models.Model):
    GRADING_TYPE = [("CONFIDENCE", "Confidence"), ("QUALITY", "Quality"), ("MISC", "Misc")]
    descriptor = models.CharField(max_length=2, help_text="Q1, C1, etc")
    description = models.TextField(max_length=250)
    type = models.CharField(max_length=20, choices=GRADING_TYPE, help_text="Type of grading")

    def __str__(self):
        return self.descriptor


class FileStore(models.Model):
    descriptor = models.CharField(max_length=100)
    virtual_location = models.CharField(
        max_length=100, help_text="USB, Rosa, email, etc"
    )
    physical_location = models.CharField(
        max_length=100, blank=True, help_text="Cupboard, room, building, etc"
    )  # cupboard, room, building, address
    physical_location_organisation = models.ForeignKey(
        Organisation, on_delete=models.CASCADE
    )

    def __str__(self):
        return self.descriptor


class DocumentFile(models.Model):
    FILETYPE_CHOICES = [(1, "Excel"), (2, "Word"), (3, "PDF"), (4, "Hard Copy")]
    name = models.CharField(max_length=255)
    type = models.IntegerField(choices=FILETYPE_CHOICES, default=1)
    file_store_location = models.ForeignKey(FileStore, on_delete=models.CASCADE)


class ApplicableSystem(models.Model):
    def get_sentinel_org():
        """
        We need this so that we can ensure models.SET() is applied with a callable
        to handle when Users are deleted from the system, preventing the Organisation
        objects related to them being deleted also.
        """
        return Organisation.objects.get_or_create(name="DELETED ORGANISATION")[0]

    name = models.CharField(max_length=256)
    description = models.TextField(max_length=1000)
    organisation = models.ForeignKey(
        Organisation, on_delete=models.SET(get_sentinel_org)
    )
    caf = models.ForeignKey("CAF", on_delete=models.CASCADE, blank=True, null=True, related_name="applicable_systems")

    class Meta:
        verbose_name = "Applicable System"

    def __str__(self):
        return f"{self.organisation.name} | {self.name}"


class CAF(models.Model):
    quality_grading = models.ForeignKey(Grading, on_delete=models.CASCADE, blank=True, null=True,
                                        related_name="quality_grading")
    confidence_grading = models.ForeignKey(Grading, on_delete=models.CASCADE, blank=True, null=True,
                                           related_name="confidence_grading")
    file = models.ForeignKey(DocumentFile, on_delete=models.CASCADE, blank=True, null=True)
    version = models.CharField(max_length=10, blank=True, null=True)
    triage_review_date = models.DateField(blank=True, null=True)
    triage_review_inspector = models.ForeignKey(Person, on_delete=models.CASCADE, blank=True, null=True)
    comments = models.TextField(max_length=1000)

    class Meta:
        verbose_name = "CAF"

    def __str__(self):
        # Get the organisation and applicable system
        org = ApplicableSystem.objects.filter(caf=self).first()
        return f"CAF | {org.name}"