~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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# Copyright 2009 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

# pylint: disable-msg=E0211,E0213

"""Question message interface."""

__metaclass__ = type

__all__ = [
    'IQuestionMessage',
    ]

from lazr.restful.declarations import (
    export_as_webservice_entry,
    exported,
    )
from lazr.restful.fields import Reference
from zope.interface import Interface
from zope.schema import (
    Bool,
    Choice,
    Int,
    )

from lp import _
from lp.answers.enums import (
    QuestionAction,
    QuestionStatus,
    )
from lp.services.messages.interfaces.message import IMessage


class IQuestionMessage(IMessage):
    """A message part of a question.

    It adds attributes to the IMessage interface.
    """
    export_as_webservice_entry(as_of='devel')

    # This is really an Object field with schema=IQuestion, but that
    # would create a circular dependency between IQuestion
    # and IQuestionMessage
    question = exported(Reference(
        title=_("The question related to this message."), schema=Interface,
        description=_("An IQuestion object."), required=True, readonly=True),
        as_of="devel")
    action = exported(Choice(
        title=_("Action operated on the question by this message."),
        required=True, readonly=True, default=QuestionAction.COMMENT,
        vocabulary=QuestionAction),
        as_of="devel")
    new_status = exported(Choice(
        title=_("Question status after message"),
        description=_("The status of the question after the transition "
        "related the action operated by this message."), required=True,
        readonly=True, default=QuestionStatus.OPEN,
        vocabulary=QuestionStatus),
        as_of="devel")
    index = Int(
        title=_("Message index."),
        description=_("The messages 0-index in the question's list of "
        "messages."),
        readonly=True)
    display_index = exported(Int(
        title=_("Human readable Message index."),
        description=_("The message's index in the question's list of "
        "messages."),
        readonly=True), exported_as='index')
    visible = exported(Bool(
        title=_("Message visibility."),
        description=_("Whether or not the message is visible."),
        readonly=True),
        as_of="devel")