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

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