www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/entityqueue/src/EntitySubqueueInterface.php

   1 <?php
   2
   3 namespace Drupal\entityqueue;
   4
   5 use Drupal\Core\Entity\ContentEntityInterface;
   6 use Drupal\Core\Entity\EntityChangedInterface;
   7 use Drupal\Core\Entity\EntityInterface;
   8 use Drupal\user\EntityOwnerInterface;
   9
  10 /**
  11  * Provides an interface defining a EntityQueue entity.
  12  */
  13 interface EntitySubqueueInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {
  14
  15   /**
  16    * Returns the subqueue's parent queue entity.
  17    *
  18    * @return \Drupal\entityqueue\EntityQueueInterface
  19    *   The parent queue entity.
  20    */
  21   public function getQueue();
  22
  23   /**
  24    * Sets the subqueue's parent queue entity.
  25    *
  26    * @param \Drupal\entityqueue\EntityQueueInterface $queue
  27    *   The parent queue entity.
  28    *
  29    * @return $this
  30    */
  31   public function setQueue(EntityQueueInterface $queue);
  32
  33   /**
  34    * Adds an entity to a subqueue
  35    *
  36    * @param \Drupal\Core\Entity\EntityInterface $entity
  37    *   An entity object.
  38    *
  39    * @return $this
  40    */
  41   public function addItem(EntityInterface $entity);
  42
  43   /**
  44    * Removes an entity from a subqueue
  45    *
  46    * @param \Drupal\Core\Entity\EntityInterface $entity
  47    *   An entity object.
  48    *
  49    * @return $this
  50    */
  51   public function removeItem(EntityInterface $entity);
  52
  53   /**
  54    * Gets the subqueue title.
  55    *
  56    * @return string
  57    *   Title of the subqueue.
  58    */
  59   public function getTitle();
  60
  61   /**
  62    * Sets the subqueue title.
  63    *
  64    * @param string $title
  65    *   The subqueue title.
  66    *
  67    * @return \Drupal\entityqueue\EntitySubqueueInterface
  68    *   The called subqueue entity.
  69    */
  70   public function setTitle($title);
  71
  72   /**
  73    * Gets the subqueue creation timestamp.
  74    *
  75    * @return int
  76    *   Creation timestamp of the subqueue.
  77    */
  78   public function getCreatedTime();
  79
  80   /**
  81    * Sets the subqueue creation timestamp.
  82    *
  83    * @param int $timestamp
  84    *   The subqueue creation timestamp.
  85    *
  86    * @return \Drupal\entityqueue\EntitySubqueueInterface
  87    *   The called subqueue entity.
  88    */
  89   public function setCreatedTime($timestamp);
  90
  91 }