commerce_funds-8.x-1.7/src/Entity/TransactionInterface.php

<?php

namespace Drupal\commerce_funds\Entity;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\commerce_price\Entity\CurrencyInterface;
use Drupal\user\EntityOwnerInterface;
use Drupal\user\UserInterface;

/**
 * Provides an interface for Transaction entity.
 *
 * @ingroup commerce_funds
 */
interface TransactionInterface extends ContentEntityInterface, EntityOwnerInterface {

  /**
   * Transaction status.
   *
   * The list of available status
   * for transactions.
   */
  public const TRANSACTION_STATUS = [
    'pending' => 'Pending',
    'completed' => 'Completed',
    'approved' => 'Approved',
    'canceled' => 'Canceled',
    'declined' => 'Declined',
  ];

  /**
   * Get the issuer user.
   *
   * @return \Drupal\user\UserInterface
   *   The issuer user.
   */
  public function getIssuer(): UserInterface;

  /**
   * Get the issuer ID.
   *
   * @return int
   *   The issuer uid.
   */
  public function getIssuerId(): int;

  /**
   * Set the issuer ID.
   *
   * @param int $uid
   *   The user uid.
   *
   * @return $this
   */
  public function setIssuerId($uid);

  /**
   * Get the recipient object.
   *
   * @return \Drupal\user\UserInterface
   *   The recipient user.
   */
  public function getRecipient(): UserInterface;

  /**
   * Get the recipient ID.
   *
   * @return int
   *   The recipient uid.
   */
  public function getRecipientId(): int;

  /**
   * Set the recipient ID.
   *
   * @param int $uid
   *   The user uid.
   *
   * @return $this
   */
  public function setRecipientId($uid);

  /**
   * Get the transaction timestamp.
   *
   * @return int
   *   The transaction timestamp.
   */
  public function getCreatedTime();

  /**
   * Set the created time.
   *
   * @param int $timestamp
   *   The timestamp.
   *
   * @return $this
   */
  public function setCreatedTime($timestamp);

  /**
   * Get the transaction method.
   *
   * @return string
   *   The transaction method.
   */
  public function getMethod();

  /**
   * Set the transaction method.
   *
   * @param string $method
   *   The transaction method.
   *
   * @return $this
   */
  public function setMethod($method);

  /**
   * Get the transaction brut amount.
   *
   * @return float
   *   The transaction brut amount.
   */
  public function getBrutAmount();

  /**
   * Set the brut amount.
   *
   * @param float $brut_amount
   *   The transaction brut amount.
   *
   * @return $this
   */
  public function setBrutAmount($brut_amount);

  /**
   * Get the transaction net amount.
   *
   * @return float
   *   The transaction net amount.
   */
  public function getNetAmount();

  /**
   * Set the net amount.
   *
   * @param float $net_amount
   *   The transaction net amount.
   *
   * @return $this
   */
  public function setNetAmount($net_amount);

  /**
   * Get the transaction fee.
   *
   * @return float
   *   The transaction fee.
   */
  public function getFee();

  /**
   * Set the fee.
   *
   * @param float $fee
   *   The transaction fee amount.
   *
   * @return $this
   */
  public function setFee($fee);

  /**
   * Get the transaction currency.
   *
   * @return \Drupal\commerce_price\Entity\Currency
   *   The transaction currency.
   */
  public function getCurrency();

  /**
   * Set the currency.
   *
   * @param \Drupal\commerce_price\Entity\CurrencyInterface $currency
   *   The transaction currency.
   *
   * @return $this
   */
  public function setCurrency(CurrencyInterface $currency);

  /**
   * Get the transaction currency code.
   *
   * @return string
   *   The transaction currency code.
   */
  public function getCurrencyCode();

  /**
   * Set the currency.
   *
   * @param string $currency_code
   *   The transaction currency code.
   *
   * @return $this
   */
  public function setCurrencyCode($currency_code);

  /**
   * Get the converted currency.
   *
   * @return \Drupal\commerce_price\Entity\Currency
   *   The transaction converted currency.
   */
  public function getFromCurrency();

  /**
   * Set the converted currency.
   *
   * @param \Drupal\commerce_price\Entity\CurrencyInterface $currency
   *   The transaction converted currency.
   *
   * @return $this
   */
  public function setFromCurrency(CurrencyInterface $currency);

  /**
   * Get the converted currency code.
   *
   * @return string
   *   The transaction converted currency code.
   */
  public function getFromCurrencyCode();

  /**
   * Set the converted currency.
   *
   * @param string $currency_code
   *   The transaction converted currency code.
   *
   * @return $this
   */
  public function setFromCurrencyCode($currency_code);

  /**
   * Get the transaction status.
   *
   * @return string
   *   The transaction status.
   */
  public function getStatus();

  /**
   * Set the status.
   *
   * @param string $status
   *   The transaction status.
   *
   * @return $this
   */
  public function setStatus($status);

  /**
   * Get the transaction notes.
   *
   * @return string
   *   The transaction notes.
   */
  public function getNotes();

  /**
   * Set the notes.
   *
   * @param string $notes
   *   The transaction notes.
   *
   * @return $this
   */
  public function setNotes($notes);

  /**
   * Get the transaction hash.
   *
   * @return string
   *   The transaction hash.
   */
  public function getHash();

  /**
   * Set the hash.
   *
   * @param string $hash
   *   The transaction hash.
   *
   * @return $this
   */
  public function setHash($hash);

}