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.PaginationOption;
  27 import org.onap.cps.spi.model.DataNode;
  28
  29 /*
  30  * Query interface for handling cps queries.
  31  */
  32 public interface CpsQueryService {
  33
  34     /**
  35      * Get data nodes for the given dataspace and anchor by cps path.
  36      *
  37      * @param dataspaceName          dataspace name
  38      * @param anchorName             anchor name
  39      * @param cpsPath                cps path
  40      * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
  41      *                               included in the output
  42      * @return a collection of data nodes
  43      */
  44     Collection<DataNode> queryDataNodes(String dataspaceName, String anchorName,
  45                                         String cpsPath, FetchDescendantsOption fetchDescendantsOption);
  46
  47     /**
  48      * Get data nodes for the given dataspace across all anchors by cps path.
  49      *
  50      * @param dataspaceName dataspace name
  51      * @param cpsPath CPS path
  52      * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
  53      *                               included in the output
  54      * @param paginationOption pagination option
  55      * @return a collection of data nodes
  56      */
  57     Collection<DataNode> queryDataNodesAcrossAnchors(String dataspaceName, String cpsPath,
  58                                                      FetchDescendantsOption fetchDescendantsOption,
  59                                                      PaginationOption paginationOption);
  60
  61     /**
  62      * Query total number of anchors for given dataspace name and cps path.
  63      * @param dataspaceName dataspace name
  64      * @param cpsPath cps path
  65      * @return total number of anchors for given dataspace name and cps path.
  66      */
  67     Integer countAnchorsForDataspaceAndCpsPath(String dataspaceName, String cpsPath);
  68 }