cps-service/src/main/java/org/onap/cps/api/CpsQueryService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.onap.cps.api;
  21
  22 import java.util.Collection;
  23 import org.checkerframework.checker.nullness.qual.NonNull;
  24 import org.onap.cps.spi.FetchDescendantsOption;
  25 import org.onap.cps.spi.model.DataNode;
  26
  27 /*
  28  * Query interface for handling cps queries.
  29  */
  30 public interface CpsQueryService {
  31
  32     /**
  33      * Get data nodes for the given dataspace and anchor by cps path.
  34      *
  35      * @param dataspaceName          dataspace name
  36      * @param anchorName             anchor name
  37      * @param cpsPath                cps path
  38      * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
  39      *                               included in the output
  40      * @return a collection of data nodes
  41      */
  42     Collection<DataNode> queryDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
  43         @NonNull String cpsPath, @NonNull FetchDescendantsOption fetchDescendantsOption);
  44
  45 }