PackageTypeInterface.php in Commerce Shipping 8.2

Namespace

Drupal\commerce_shipping\Plugin\Commerce\PackageType

File

src/Plugin/Commerce/PackageType/PackageTypeInterface.php

<?php

namespace Drupal\commerce_shipping\Plugin\Commerce\PackageType;


/**
 * Defines the interface for package types.
 */
interface PackageTypeInterface {

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

  /**
   * Gets the package type remote ID.
   *
   * @return string
   *   The package type remote ID, or "custom" if the package type was not
   *   predefined by the remote API.
   */
  public function getRemoteId();

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

  /**
   * Gets the package type length.
   *
   * @return \Drupal\physical\Length
   *   The package type length.
   */
  public function getLength();

  /**
   * Gets the package type width.
   *
   * @return \Drupal\physical\Length
   *   The package type width.
   */
  public function getWidth();

  /**
   * Gets the package type height.
   *
   * @return \Drupal\physical\Length
   *   The package type height.
   */
  public function getHeight();

  /**
   * Gets the package type weight.
   *
   * This is the weight of an empty package.
   *
   * @return \Drupal\physical\Weight
   *   The package type weight.
   */
  public function getWeight();

}

Interfaces

Name	Description
PackageTypeInterface	Defines the interface for package types.