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
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.api;
23 import java.util.Collection;
24 import org.checkerframework.checker.nullness.qual.NonNull;
25 import org.onap.cps.spi.FetchDescendantsOption;
26 import org.onap.cps.spi.model.DataNode;
29 * Query interface for handling cps queries.
31 public interface CpsQueryService {
34 * Get data nodes for the given dataspace and anchor by cps path.
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
43 Collection<DataNode> queryDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
44 @NonNull String cpsPath, @NonNull FetchDescendantsOption fetchDescendantsOption);