RequestNodeActionMessage

Complexity

Total Complexity

3

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	create_from_json()	0	15	1
A	__init__()	0	54	1
A	send_message()	0	9	1

"""
Enarksh

Copyright 2013-2016 Set Based IT Consultancy

Licence MIT
"""
from enarksh.message.Message import Message

The name message does not seem to exist in module enarksh.

The import enarksh.message.Message could not be resolved.

from enarksh.message.MessageController import MessageController

The name message does not seem to exist in module enarksh.

The import enarksh.message.MessageController could not be resolved.

class RequestNodeActionMessage(Message):
    """
    Message type for requesting a node action.
    """
    MESSAGE_TYPE = 'controller:RequestNodeActionMessage'
    """
    The message type.

    :type: str
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self, sch_id, rnd_id, act_id, usr_login, mail_on_completion, mail_on_error):
        """
        Object constructor.

        :param int sch_id: The ID of the schedule.
        :param int rnd_id: The ID of the run node.
        :param int act_id: The ID of the requested action.
        :param str usr_login: The name of the user who has requested the node action.
        :param bool mail_on_completion: If True the user wants to receive a mail when the schedule has completed.
        :param bool mail_on_error: If True the user wants to receive a mail when an error occurs.
        """
        Message.__init__(self, RequestNodeActionMessage.MESSAGE_TYPE)

        self.sch_id = sch_id
        """
        The ID of the schedule.

        :type: int
        """

        self.rnd_id = rnd_id
        """
        The ID of the run node.

        :type: int
        """

        self.act_id = act_id
        """
        The ID of the requested action.

        :type: int
        """

        self.usr_login = usr_login
        """
        The name of the user who has requested the node action.

        :type: int
        """

        self.mail_on_completion = mail_on_completion
        """
        If True the user wants to receive a mail when the schedule has completed.

        :type: bool
        """

        self.mail_on_error = mail_on_error
        """
        If True the user wants to receive a mail when an error occurs.

        :type: bool
        """

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def create_from_json(message):
        """
        Object constructor using JSON encoded message.

        :param * message: The message.

        :rtype: enarksh.controller.message.RequestPossibleNodeActionsMessage.RequestPossibleNodeActionsMessage
        """
        return RequestNodeActionMessage(int(message['sch_id']),
                                        int(message['rnd_id']),
                                        int(message['act_id']),
                                        message['usr_login'],
                                        bool(message['mail_on_completion']),
                                        bool(message['mail_on_error']))

    # ------------------------------------------------------------------------------------------------------------------
    def send_message(self, end_point):
        """
        Sends the message to an end point.

        :param str end_point: The end point.

        :rtype: None
        """
        self.message_controller.send_message(end_point, self)

The Instance of RequestNodeActionMessage does not seem to have a member named message_controller.

# ----------------------------------------------------------------------------------------------------------------------
MessageController.register_json_message_creator(RequestNodeActionMessage.MESSAGE_TYPE,
                                                RequestNodeActionMessage.create_from_json)