File

feature-libs/order/root/facade/order.facade.ts

Index

Methods

Methods

Abstract cancelOrder
cancelOrder(orderCode: string, cancelRequestInput: CancellationRequestEntryInputList)
Parameters :
Name Type Optional
orderCode string No
cancelRequestInput CancellationRequestEntryInputList No
Returns : void
Abstract clearConsignmentTracking
clearConsignmentTracking()

Cleaning consignment tracking

Returns : void
Abstract clearOrderDetails
clearOrderDetails()

Clears order's details

Returns : void
Abstract clearOrderList
clearOrderList()

Cleaning order list

Returns : void
Abstract getCancelOrderLoading
getCancelOrderLoading()

Returns the cancel order loading flag

Returns : Observable<boolean>
Abstract getCancelOrderSuccess
getCancelOrderSuccess()

Returns the cancel order success flag

Returns : Observable<boolean>
Abstract getConsignmentTracking
getConsignmentTracking()

Returns a consignment tracking detail

Returns : Observable<ConsignmentTracking>
Abstract getOrderDetails
getOrderDetails()

Returns an order's detail

Returns : Observable<Order>
Abstract getOrderHistoryList
getOrderHistoryList(pageSize: number)

Returns order history list

Parameters :
Name Type Optional
pageSize number No
Abstract getOrderHistoryListLoaded
getOrderHistoryListLoaded()

Returns a loaded flag for order history list

Returns : Observable<boolean>
Abstract loadConsignmentTracking
loadConsignmentTracking(orderCode: string, consignmentCode: string)

Retrieves consignment tracking details

Parameters :
Name Type Optional Description
orderCode string No

an order code

consignmentCode string No

a consignment code

Returns : void
Abstract loadOrderDetails
loadOrderDetails(orderCode: string)

Retrieves order's details

Parameters :
Name Type Optional Description
orderCode string No

an order code

Returns : void
Abstract loadOrderList
loadOrderList(pageSize: number, currentPage?: number, sort?: string)

Retrieves an order list

Parameters :
Name Type Optional Description
pageSize number No

page size

currentPage number Yes

current page

sort string Yes

sort

Returns : void
Abstract resetCancelOrderProcessState
resetCancelOrderProcessState()

Resets the cancel order process flags

Returns : void
import { Injectable } from '@angular/core';
import {
  CancellationRequestEntryInputList,
  facadeFactory,
  Order,
  OrderHistoryList,
} from '@spartacus/core';
import { Observable } from 'rxjs';
import { ORDER_CORE_FEATURE } from '../feature-name';
import { ConsignmentTracking } from '../model/consignment-tracking.model';

export function orderFacadeFactory() {
  return facadeFactory({
    facade: OrderFacade,
    feature: ORDER_CORE_FEATURE,
    methods: [
      'getOrderDetails',
      'loadOrderDetails',
      'clearOrderDetails',
      'getOrderHistoryList',
      'getOrderHistoryListLoaded',
      'loadOrderList',
      'clearOrderList',
      'getConsignmentTracking',
      'loadConsignmentTracking',
      'clearConsignmentTracking',
      'cancelOrder',
      'getCancelOrderLoading',
      'getCancelOrderSuccess',
      'resetCancelOrderProcessState',
    ],
    async: true,
  });
}

@Injectable({
  providedIn: 'root',
  useFactory: orderFacadeFactory,
})
export abstract class OrderFacade {
  /**
   * Returns an order's detail
   */
  abstract getOrderDetails(): Observable<Order>;

  /**
   * Retrieves order's details
   *
   * @param orderCode an order code
   */
  abstract loadOrderDetails(orderCode: string): void;

  /**
   * Clears order's details
   */
  abstract clearOrderDetails(): void;

  /**
   * Returns order history list
   */
  abstract getOrderHistoryList(
    pageSize: number
  ): Observable<OrderHistoryList | undefined>;

  /**
   * Returns a loaded flag for order history list
   */
  abstract getOrderHistoryListLoaded(): Observable<boolean>;

  /**
   * Retrieves an order list
   * @param pageSize page size
   * @param currentPage current page
   * @param sort sort
   */
  abstract loadOrderList(
    pageSize: number,
    currentPage?: number,
    sort?: string
  ): void;

  /**
   * Cleaning order list
   */
  abstract clearOrderList(): void;

  /**
   *  Returns a consignment tracking detail
   */
  abstract getConsignmentTracking(): Observable<ConsignmentTracking>;

  /**
   * Retrieves consignment tracking details
   * @param orderCode an order code
   * @param consignmentCode a consignment code
   */
  abstract loadConsignmentTracking(
    orderCode: string,
    consignmentCode: string
  ): void;

  /**
   * Cleaning consignment tracking
   */
  abstract clearConsignmentTracking(): void;

  /*
   * Cancel an order
   */
  abstract cancelOrder(
    orderCode: string,
    cancelRequestInput: CancellationRequestEntryInputList
  ): void;

  /**
   * Returns the cancel order loading flag
   */
  abstract getCancelOrderLoading(): Observable<boolean>;

  /**
   * Returns the cancel order success flag
   */
  abstract getCancelOrderSuccess(): Observable<boolean>;

  /**
   * Resets the cancel order process flags
   */
  abstract resetCancelOrderProcessState(): void;
}

result-matching ""

    No results matching ""