~launchpad-pqm/launchpad/devel

# Copyright 2011 Canonical Ltd.  This software is licensed under the

# GNU Affero General Public License version 3 (see the file LICENSE).

"""Interface for the Jobs system for questions."""

__metaclass__ = type

__all__ = [

    'IQuestionJob',

    'IQuestionEmailJob',

    'IQuestionEmailJobSource',

    ]

from zope.interface import (

    Attribute,

    Interface,

    )

from zope.schema import (

    Choice,

    Field,

    Int,

    Object,

    )

from lp import _

from lp.answers.enums import QuestionJobType

from lp.services.job.interfaces.job import (

    IJob,

    IJobSource,

    IRunnableJob,

    )

class IQuestionJob(Interface):

    """A Job related to a question."""

    id = Int(

        title=_('DB ID'), required=True, readonly=True,

        description=_("The tracking number for this job."))

    job = Object(

        title=_('The common Job attributes'),

        schema=IJob, required=True)

    job_type = Choice(

        title=_('Job type'), vocabulary=QuestionJobType,

        required=True, readonly=True)

    question = Field(

        title=_("The question related to this job."),

        description=_("An IQuestion."), required=True, readonly=True)

    metadata = Attribute('A dict of data about the job.')

class IQuestionEmailJob(IQuestionJob, IRunnableJob):

    user = Attribute('The `IPerson` who triggered the email.')

    subject = Attribute('The subject of the email.')

    body = Attribute(

        'The body of the email that is common to all recipients.')

    headers = Attribute(

        'The headers of the email that are common to all recipients.')

    from_address = Attribute(

        'The formatted email address for the user and question.')

    recipients = Attribute('The recipient of the email.')

    def buildBody(rationale):

        """Return the formatted email body with the rationale included."""

class IQuestionEmailJobSource(IJobSource):

    """An interface for acquiring IQuestionJob."""

    def create(question, user, recipient_set, subject, body, headers):

        """Create a new IQuestionJob.

        :param question: An `IQuestion`.

        :param user: An `IPerson`.

        :param recipient_set: A `QuestionRecipientSet`.

        :param subject: The subject of the email.

        :param body: The text of the email that is common to all recipients.

        :param headers: A dict of headers for the email that are common to

            all recipients.

        """