recurring_events-2.0.x-dev/modules/recurring_events_registration/src/Entity/RegistrantInterface.php

<?php

declare(strict_types=1);

namespace Drupal\recurring_events_registration\Entity;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\recurring_events\Entity\EventInstance;
use Drupal\recurring_events\Entity\EventSeries;
use Drupal\user\EntityOwnerInterface;

/**
 * Provides an interface for defining Registrant entities.
 *
 * @ingroup recurring_events_registration
 */
interface RegistrantInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {

  /**
   * Gets the Registrant creation timestamp.
   *
   * @return int
   *   Creation timestamp of the Registrant.
   */
  public function getCreatedTime();

  /**
   * Sets the Registrant creation timestamp.
   *
   * @param int $timestamp
   *   The Registrant creation timestamp.
   *
   * @return \Drupal\recurring_events_registration\Entity\RegistrantInterface
   *   The called Registrant entity.
   */
  public function setCreatedTime($timestamp);

  /**
   * Returns the event instance.
   *
   * @return \Drupal\recurring_events\Entity\EventInstance|null
   *   The eventinstance entity, or NULL if no event instance has been set yet.
   */
  public function getEventInstance(): ?EventInstance;

  /**
   * Returns the event series.
   *
   * @return \Drupal\recurring_events\Entity\EventSeries|null
   *   The event series entity, or NULL if no event series has been set.
   */
  public function getEventSeries(): ?EventSeries;

  /**
   * Returns the langcode of the language used during registration.
   *
   * @return string
   *   The langcode.
   */
  public function getLangcode(): string;

  /**
   * Sets the langcode.
   *
   * @param string $langcode
   *   The langcode.
   *
   * @return \Drupal\recurring_events_registration\Entity\RegistrantInterface
   *   The registrant entity, for chaining.
   */
  public function setLangcode(string $langcode): RegistrantInterface;

  /**
   * Gets whether the registrant is on the waitlist.
   *
   * @return bool
   *   TRUE if the registrant is on the waitlist.
   */
  public function getWaitlist(): bool;

  /**
   * Sets whether the registrant is on the waitlist.
   *
   * @param bool $waitlist
   *   TRUE if the registrant is on the waitlist.
   *
   * @return \Drupal\recurring_events_registration\Entity\RegistrantInterface
   *   The registrant entity, for chaining.
   */
  public function setWaitlist(bool $waitlist): RegistrantInterface;

}