File

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

Index

Methods

Methods

Abstract cancelOrderReturnRequest
cancelOrderReturnRequest(returnRequestCode: string, returnRequestModification: ReturnRequestModification)
Parameters :
Name Type Optional
returnRequestCode string No
returnRequestModification ReturnRequestModification No
Returns : void
Abstract clearOrderReturnRequestDetail
clearOrderReturnRequestDetail()

Cleaning order return request details

Returns : void
Abstract clearOrderReturnRequestList
clearOrderReturnRequestList()

Cleaning order return request list

Returns : void
Abstract createOrderReturnRequest
createOrderReturnRequest(returnRequestInput: ReturnRequestEntryInputList)

Create order return request

Parameters :
Name Type Optional Description
returnRequestInput ReturnRequestEntryInputList No

order return request entry input

Returns : void
Abstract getCancelReturnRequestLoading
getCancelReturnRequestLoading()

Returns the cancel return request loading flag

Returns : Observable<boolean>
Abstract getCancelReturnRequestSuccess
getCancelReturnRequestSuccess()

Returns the cancel return request success flag

Returns : Observable<boolean>
Abstract getOrderReturnRequest
getOrderReturnRequest()

Return an order return request

Returns : Observable<ReturnRequest>
Abstract getOrderReturnRequestList
getOrderReturnRequestList(pageSize: number)

Gets order return request list

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

Get the order return request loading flag

Returns : Observable<boolean>
Abstract getReturnRequestSuccess
getReturnRequestSuccess()

Get the order return request success flag

Returns : Observable<boolean>
Abstract loadOrderReturnRequestDetail
loadOrderReturnRequestDetail(returnRequestCode: string)

Loads order return request detail

Parameters :
Name Type Optional
returnRequestCode string No
Returns : void
Abstract loadOrderReturnRequestList
loadOrderReturnRequestList(pageSize: number, currentPage?: number, sort?: string)

Loads order return request list

Parameters :
Name Type Optional Description
pageSize number No

page size

currentPage number Yes

current page

sort string Yes

sort

Returns : void
Abstract resetCancelReturnRequestProcessState
resetCancelReturnRequestProcessState()

Resets the cancel return request process flags

Returns : void
import { Injectable } from '@angular/core';
import {
  facadeFactory,
  ReturnRequest,
  ReturnRequestEntryInputList,
  ReturnRequestList,
  ReturnRequestModification,
} from '@spartacus/core';
import { Observable } from 'rxjs';
import { ORDER_CORE_FEATURE } from '../feature-name';

export function orderReturnRequestFacadeFactory() {
  return facadeFactory({
    facade: OrderReturnRequestFacade,
    feature: ORDER_CORE_FEATURE,
    methods: [
      'createOrderReturnRequest',
      'getOrderReturnRequest',
      'getOrderReturnRequestList',
      'loadOrderReturnRequestDetail',
      'loadOrderReturnRequestList',
      'clearOrderReturnRequestList',
      'getReturnRequestLoading',
      'getReturnRequestSuccess',
      'clearOrderReturnRequestDetail',
      'cancelOrderReturnRequest',
      'getCancelReturnRequestLoading',
      'getCancelReturnRequestSuccess',
      'resetCancelReturnRequestProcessState',
    ],
    async: true,
  });
}

@Injectable({
  providedIn: 'root',
  useFactory: orderReturnRequestFacadeFactory,
})
export abstract class OrderReturnRequestFacade {
  /**
   * Create order return request
   * @param orderCode an order code
   * @param returnRequestInput order return request entry input
   */
  abstract createOrderReturnRequest(
    returnRequestInput: ReturnRequestEntryInputList
  ): void;

  /**
   * Return an order return request
   */
  abstract getOrderReturnRequest(): Observable<ReturnRequest>;

  /**
   * Gets order return request list
   */
  abstract getOrderReturnRequestList(
    pageSize: number
  ): Observable<ReturnRequestList | undefined>;

  /**
   * Loads order return request detail
   * @param returnRequestCode
   */
  abstract loadOrderReturnRequestDetail(returnRequestCode: string): void;

  /**
   * Loads order return request list
   * @param pageSize page size
   * @param currentPage current page
   * @param sort sort
   */
  abstract loadOrderReturnRequestList(
    pageSize: number,
    currentPage?: number,
    sort?: string
  ): void;

  /**
   * Cleaning order return request list
   */
  abstract clearOrderReturnRequestList(): void;

  /**
   * Get the order return request loading flag
   */
  abstract getReturnRequestLoading(): Observable<boolean>;

  /**
   * Get the order return request success flag
   */
  abstract getReturnRequestSuccess(): Observable<boolean>;

  /**
   * Cleaning order return request details
   */
  abstract clearOrderReturnRequestDetail(): void;

  /*
   * Cancel order return request
   */
  abstract cancelOrderReturnRequest(
    returnRequestCode: string,
    returnRequestModification: ReturnRequestModification
  ): void;

  /**
   * Returns the cancel return request loading flag
   */
  abstract getCancelReturnRequestLoading(): Observable<boolean>;

  /**
   * Returns the cancel return request success flag
   */
  abstract getCancelReturnRequestSuccess(): Observable<boolean>;

  /**
   * Resets the cancel return request process flags
   */
  abstract resetCancelReturnRequestProcessState(): void;
}

result-matching ""

    No results matching ""