entity_generic-8.x-3.x-dev/src/Entity/GenericTypeInterface.php

<?php

namespace Drupal\entity_generic\Entity;

use Drupal\Core\Entity\RevisionableEntityBundleInterface;

/**
 * Provides an interface defining a type entity.
 */
interface GenericTypeInterface extends GenericConfigInterface, RevisionableEntityBundleInterface {

  /**
   * Determines whether the entity type is locked.
   *
   * @return string|false
   *   The module name that locks the type or FALSE.
   */
  public function isLocked();

  /**
   * Gets the help information.
   *
   * @return string
   *   The help information of this entity type.
   */
  public function getHelp();

  /**
   * Gets the description.
   *
   * @return string
   *   The description of this entity type.
   */
  public function getDescription();

  /**
   * Sets whether a new revision should be created by default.
   *
   * @param bool $new_revision
   *   TRUE if a new revision should be created by default.
   */
  public function setNewRevision($new_revision);

}