@eclipse-scout/core/src/lookup/RemoteLookupCall.ts

Eclipse Scout runtime

/*
 * Copyright (c) 2010, 2023 BSI Business Systems Integration AG
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 */
import {arrays, LookupCall, LookupFieldAdapter, LookupResult, LookupRow, objects, QueryBy, RemoteLookupRequest, scout} from '../index';
import $ from 'jquery';
import Deferred = JQuery.Deferred;

export class RemoteLookupCall<TKey> extends LookupCall<TKey> {
  adapter: LookupFieldAdapter;
  deferred: Deferred<LookupResult<TKey>, { abort: boolean }> & { requestParameter?: RemoteLookupRequest<string | TKey | void> };

  constructor(adapter: LookupFieldAdapter) {
    super();
    this.adapter = adapter;
    this.deferred = null;
  }

  protected override _getAll(): JQuery.Promise<LookupResult<TKey>> {
    this._newDeferred(new RemoteLookupRequest(QueryBy.ALL));
    this.adapter.sendLookup(QueryBy.ALL);
    return this.deferred.promise();
  }

  protected override _getByText(text: string): JQuery.Promise<LookupResult<TKey>> {
    this._newDeferred(new RemoteLookupRequest(QueryBy.TEXT, text));
    this.adapter.sendLookup(QueryBy.TEXT, text);
    return this.deferred.promise();
  }

  protected override _getByKey(key: TKey): JQuery.Promise<LookupResult<TKey>> {
    this._newDeferred(new RemoteLookupRequest(QueryBy.KEY, key));
    this.adapter.sendLookup(QueryBy.KEY, key);
    return this.deferred.promise();
  }

  protected override _getByRec(rec: TKey): JQuery.Promise<LookupResult<TKey>> {
    this._newDeferred(new RemoteLookupRequest(QueryBy.REC, rec));
    this.adapter.sendLookup(QueryBy.REC, rec);
    return this.deferred.promise();
  }

  resolveLookup(lookupResult: LookupResult<TKey>) {
    if (!this._belongsToLatestRequest(lookupResult)) {
      $.log.isTraceEnabled() && $.log.trace('(RemoteLookupCall#resolveLookup) ignore lookupResult. Does not belong to latest request',
        objects.optProperty(this.deferred, 'requestParameter'));
      return;
    }

    lookupResult.lookupRows = arrays.ensure(lookupResult.lookupRows)
      .map(lookupRowObject => scout.create(LookupRow, lookupRowObject) as LookupRow<TKey>);
    this.deferred.resolve(lookupResult);
  }

  protected _belongsToLatestRequest(lookupResult: LookupResult<TKey>): boolean {
    // This case may happen when a lookup is initialized by the UI server (not the browser)
    // Note: currently we simply ignore that case because it can only occur when the UI server
    // calls doSearch in unexpected conditions. However, we could support this case in a similar
    // way than we support requestInput().
    if (!this.deferred) {
      return false;
    }

    let propertyName = lookupResult.queryBy.toLowerCase(),
      requestData = lookupResult[propertyName],
      resultParameter = new RemoteLookupRequest(lookupResult.queryBy, requestData);
    return this.deferred.requestParameter.equals(resultParameter);
  }

  /**
   * Creates a new deferred and rejects the previous one.
   */
  protected _newDeferred(requestParameter: RemoteLookupRequest<string | TKey | void>) {
    if (this.deferred) {
      this.deferred.reject({
        abort: true
      });
    }
    this.deferred = $.Deferred();
    this.deferred.requestParameter = requestParameter;
  }
}