~launchpad-pqm/launchpad/devel

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
# Copyright 2009-2011 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

# pylint: disable-msg=E0213

"""Specification message interfaces."""

__metaclass__ = type
__all__ = [
    'ISpecificationMessage',
    'ISpecificationMessageSet',
    ]

from lazr.restful.fields import Reference
from zope.interface import Interface
from zope.schema import Bool

from lp.blueprints.interfaces.specification import ISpecification
from lp.services.messages.interfaces.message import IMessage


class ISpecificationMessage(Interface):
    """A link between a specification and a message."""

    specification = Reference(schema=ISpecification,
        title=u"The specification.")
    message = Reference(schema=IMessage, title=u"The message.")
    visible = Bool(title=u"Is this message visible?", required=False,
        default=True)


class ISpecificationMessageSet(Interface):
    """The set of all ISpecificationMessages."""

    def createMessage(subject, specification, owner, content=None):
        """Create an ISpecificationMessage.

        title -- a string
        specification -- an ISpecification
        owner -- an IPerson
        content -- a string

        The created message will have the specification's initial message as
        its parent.

        Returns the created ISpecificationMessage.
        """

    def get(specificationmessageid):
        """Retrieve an ISpecificationMessage by its ID."""

    def getBySpecificationAndMessage(specification, message):
        """Return the corresponding ISpecificationMesssage.

        Return None if no such ISpecificationMesssage exists.
        """