a12s-1.0.0-beta7/modules/layout/src/Entity/DisplayOptionsInstanceInterface.php

<?php

namespace Drupal\a12s_layout\Entity;

use Drupal\a12s_layout\DisplayOptions\DisplayTemplatePluginInterface;
use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides an interface defining a display options instance entity type.
 */
interface DisplayOptionsInstanceInterface extends ConfigEntityInterface {

  /**
   * Whether the instance has a defined plugin.
   *
   * @return bool
   *   TRUE if the plugin exists.
   */
  public function hasPlugin(): bool;

  /**
   * Get the plugin ID.
   *
   * @return string
   *   The plugin ID for this configuration.
   */
  public function getPluginId(): string;

  /**
   * Sets the plugin ID for the instance.
   *
   * @param string $pluginId
   *   The ID of the plugin to be set.
   */
  public function setPluginId(string $pluginId): void;

  /**
   * Returns the plugin instance.
   *
   * @return \Drupal\a12s_layout\DisplayOptions\DisplayTemplatePluginInterface
   *   The plugin instance for this configuration.
   */
  public function getPlugin(): DisplayTemplatePluginInterface;

  /**
   * Get the related Display Template, if applicable.
   *
   * @return \Drupal\a12s_layout\DisplayOptions\DisplayTemplatePluginInterface|null
   *   The Display Template plugin instance.
   */
  public function getTemplate(): DisplayTemplatePluginInterface|null;

}