CPS-265 - updating cps path to support include-descendants option.
[cps.git] / cps-service / src / main / java / org / onap / cps / api / CpsQueryService.java
index b432af8..0f4bf2d 100644 (file)
@@ -21,6 +21,7 @@ package org.onap.cps.api;
 
 import java.util.Collection;
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.onap.cps.spi.FetchDescendantsOption;
 import org.onap.cps.spi.model.DataNode;
 
 /*
@@ -34,9 +35,11 @@ public interface CpsQueryService {
      * @param dataspaceName          dataspace name
      * @param anchorName             anchor name
      * @param cpsPath                cps path
+     * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
+     *                               included in the output
      * @return a collection of data nodes
      */
     Collection<DataNode> queryDataNodes(@NonNull String dataspaceName, @NonNull String anchorName,
-        @NonNull String cpsPath);
+        @NonNull String cpsPath, @NonNull FetchDescendantsOption fetchDescendantsOption);
 
 }