You are here

AdjustmentTypeInterface.php in Commerce Core 8.2

File

modules/order/src/Plugin/Commerce/AdjustmentType/AdjustmentTypeInterface.php
View source
<?php

namespace Drupal\commerce_order\Plugin\Commerce\AdjustmentType;


/**
 * Defines the interface for adjustment types.
 */
interface AdjustmentTypeInterface {

  /**
   * Gets the adjustment type ID.
   *
   * @return string
   *   The adjustment type ID.
   */
  public function getId();

  /**
   * Gets the adjustment type label.
   *
   * @return string
   *   The adjustment type label.
   */
  public function getLabel();

  /**
   * Gets the adjustment type singular label.
   *
   * @return string
   *   The adjustment type singular label.
   */
  public function getSingularLabel();

  /**
   * Gets the adjustment type plural label.
   *
   * @return string
   *   The adjustment type plural label.
   */
  public function getPluralLabel();

  /**
   * Gets the adjustment type weight.
   *
   * @return int
   *   The adjustment type weight.
   */
  public function getWeight();

  /**
   * Gets whether the adjustment type can be created from the UI.
   *
   * @return bool
   *   TRUE if the adjustment type can be created from the UI, FALSE otherwise.
   */
  public function hasUi();

}

Interfaces

Namesort descending Description
AdjustmentTypeInterface Defines the interface for adjustment types.