PriceListItemInterface.php in Commerce Pricelist 8

Namespace

Drupal\commerce_pricelist\Entity

File

src/Entity/PriceListItemInterface.php

<?php

namespace Drupal\commerce_pricelist\Entity;

use Drupal\commerce_price\Price;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\user\EntityOwnerInterface;

/**
 * Defines the interface for price list items.
 *
 * @ingroup commerce_pricelist
 */
interface PriceListItemInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {

  /**
   * Gets the price list item name.
   *
   * @return string
   *   Name of the price list item.
   */
  public function getName();

  /**
   * Sets the price list item name.
   *
   * @param string $name
   *   The price list item name.
   *
   * @return $this
   */
  public function setName($name);

  /**
   * Gets the price list item quantity.
   *
   * @return string
   *   Quantity of the price list item.
   */
  public function getQuantity();

  /**
   * Sets the price list item quantity.
   *
   * @param string $quantity
   *   The price list item quantity.
   *
   * @return $this
   */
  public function setQuantity($quantity);

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

  /**
   * Sets the price list item creation timestamp.
   *
   * @param int $timestamp
   *   The price list item creation timestamp.
   *
   *   * @return $this.
   */
  public function setCreatedTime($timestamp);

  /**
   * Sets the parent price list ID.
   *
   * @param string $price_list_id
   *   The parent price list ID.
   *
   * @return $this
   */
  public function setPriceListId($price_list_id);

  /**
   * Sets the parent price list.
   *
   * @param \Drupal\commerce_pricelist\Entity\PriceListInterface $price_list
   *   The price list entity.
   *
   * @return $this
   */
  public function setPriceList(PriceListInterface $price_list);

  /**
   * Gets the price list.
   *
   * @return $this
   */
  public function getPriceList();

  /**
   * Gets the price list ID.
   *
   * @return int
   *   The parent price list entity ID.
   */
  public function getPriceListId();

  /**
   * Gets whether the price list item has a purchased entity.
   *
   * @return bool
   *   TRUE if the price list item has a purchased entity, FALSE otherwise.
   */
  public function hasPurchasedEntity();

  /**
   * Gets the purchased entity.
   *
   * @return \Drupal\commerce\PurchasableEntityInterface|null
   *   The purchased entity, or NULL.
   */
  public function getPurchasedEntity();

  /**
   * Gets the purchased entity ID.
   *
   * @return int
   *   The purchased entity ID.
   */
  public function getPurchasedEntityId();

  /**
   * Sets the price list item purchased entity ID.
   *
   * @param string $purchased_entity_id
   *   The purchased entity ID.
   *
   * @return $this
   */
  public function setPurchasedEntityId($purchased_entity_id);

  /**
   * Gets the price list item price.
   *
   * @return \Drupal\commerce_price\Price
   *   The price.
   */
  public function getPrice();

  /**
   * Sets the price list item price.
   *
   * @param \Drupal\commerce_price\Price $price
   *   The price.
   *
   * @return $this
   */
  public function setPrice(Price $price);

  /**
   * Get whether or not the price list item is active.
   *
   * @return bool
   *   TRUE if the rice list item is acive, FALSE otherwise.
   */
  public function isActive();

  /**
   * Sets the price list item active.
   *
   * @return $this
   */
  public function setActive();

  /**
   * Set the price list item inactive.
   *
   * @return $this
   */
  public function setInactive();

}

Interfaces

Name	Description
PriceListItemInterface	Defines the interface for price list items.