<?php

namespace Drupal\custom_forms_payment;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides an interface defining a Custom forms payment method entity type.
 */
interface CustomFormsPaymentMethodInterface extends ConfigEntityInterface {

  /**
   * Get the definition for the payment method plugin.
   *
   * @return array|bool
   *   Returns an array containing the plugin definition, false on failure.
   */
  public function getPaymentPluginDefinition();

  /**
   * Get the plugin for the payment method.
   *
   * @return \Drupal\custom_forms_payment\Plugin\CustomForms\PaymentMethod\CustomFormsPaymentMethodInterface|bool
   *   Returns the payment plugin, false on failure.
   */
  public function getPaymentPlugin();

  /**
   * Get the id of the plugin for the payment method.
   *
   * @return string|bool
   *   Returns the payment plugin id, false on failure.
   */
  public function getPaymentPluginId();

  /**
   * Get the settings of the plugin for the payment method.
   *
   * @return array
   *   Returns the settings for the plugin
   */
  public function getPluginSettings();

}