<?php


namespace Drupal\custom_forms\Entity;


use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\custom_forms\CustomFormInterface;
use Drupal\user\EntityOwnerInterface;

interface CustomFormSubmissionHandlerInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {

  /**
   * Get the custom form associated with the handler.
   *
   * @return \Drupal\custom_forms\CustomFormInterface
   *   Returns the custom form associated with the handler.
   */
  public function getCustomForm() : CustomFormInterface;

  /**
   * Get the plugin definition for the handler.
   *
   * @return array|NULL
   *   Returns the plugin definition if the plugin was found, otherwise NULL.
   */
  public function getPluginDefinition() : ?array;

  /**
   * Get the plugin id used by the handler.
   *
   * @return string
   *   The plugin id.
   */
  public function getPluginId() : string;

  /**
   * Get the plugin settings.
   *
   * @return array
   *   Returns the settings array.
   */
  public function getPluginSettings() : array;

  /**
   * Gets the plugin associated with the handler.
   *
   * @return object
   *   Returns an instance of the plugin.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function getPlugin() : object;
}