#
# DBus interface for the DASD module.
#
# Copyright (C) 2018 Red Hat, Inc.
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# the GNU General Public License v.2, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY expressed or implied, including the implied warranties of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
# Public License for more details.  You should have received a copy of the
# GNU General Public License along with this program; if not, write to the
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.  Any Red Hat trademarks that are incorporated in the
# source code or documentation are not subject to the GNU General Public
# License and may only be used or replicated with the express permission of
# Red Hat, Inc.
#
from dasbus.server.interface import dbus_interface
from dasbus.typing import *  # pylint: disable=wildcard-import
from pyanaconda.modules.common.base import KickstartModuleInterfaceTemplate
from pyanaconda.modules.common.constants.objects import DASD
from pyanaconda.modules.common.containers import TaskContainer


@dbus_interface(DASD.interface_name)
class DASDInterface(KickstartModuleInterfaceTemplate):
    """DBus interface for the DASD module."""

    def IsSupported(self) -> Bool:
        """Is this module supported?"""
        return self.implementation.is_supported()

    def DiscoverWithTask(self, device_number: Str) -> ObjPath:
        """Discover a DASD.

        :param device_number: a device number
        :return: a path to a task
        :raise: DiscoveryError in case of failure
        """
        return TaskContainer.to_object_path(
            self.implementation.discover_with_task(device_number)
        )

    def FindFormattable(self, disk_names: List[Str]) -> List[Str]:
        """Find DASDs for formatting.

        :param disk_names: a list of disk names to search
        :return: a list of DASDs for formatting
        """
        return self.implementation.find_formattable(disk_names)

    def FormatWithTask(self, dasds: List[Str]) -> ObjPath:
        """Format DASDs.

        :param dasds: a list of disk names
        :return: a path to a task
        """
        return TaskContainer.to_object_path(
            self.implementation.format_with_task(dasds)
        )