summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-api/opendc/models/portfolio.py
blob: 1643e23e56c5bf82e369b9cb49ca676acfa17550 (plain)
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
from marshmallow import Schema, fields

from opendc.models.project import Project
from opendc.models.model import Model


class TargetSchema(Schema):
    """
    Schema representing a target.
    """
    enabledMetrics = fields.List(fields.String())
    repeatsPerScenario = fields.Integer(required=True)


class PortfolioSchema(Schema):
    """
    Schema representing a portfolio.
    """
    _id = fields.String(dump_only=True)
    projectId = fields.String()
    name = fields.String(required=True)
    scenarioIds = fields.List(fields.String())
    targets = fields.Nested(TargetSchema)


class Portfolio(Model):
    """Model representing a Portfolio."""

    collection_name = 'portfolios'

    def check_user_access(self, user_id, edit_access):
        """Raises an error if the user with given [user_id] has insufficient access.

        Checks access on the parent project.

        :param user_id: The User ID of the user.
        :param edit_access: True when edit access should be checked, otherwise view access.
        """
        project = Project.from_id(self.obj['projectId'])
        project.check_user_access(user_id, edit_access)