From f5a3a2177ee328ac842883a89c75169c9a651f53 Mon Sep 17 00:00:00 2001
From: seanbeirne <sean.beirne@est.tech>
Date: Mon, 6 Mar 2023 09:12:49 +0000
Subject: NCMP Inventory documentation update

- Updated release notes

Issue-ID: CPS-1494
Signed-off-by: seanbeirne <sean.beirne@est.tech>
Change-Id: I43fc285da9d6699326d5e0a933fdb3c5c7abcb12
---
 .../api/NetworkCmProxyCmHandleQueryService.java    | 29 ++++++++++++++++------
 1 file changed, 21 insertions(+), 8 deletions(-)

(limited to 'cps-ncmp-service/src/main/java/org/onap')

diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandleQueryService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandleQueryService.java
index 91e98e866..f29fd687b 100644
--- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandleQueryService.java
+++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandleQueryService.java
@@ -26,26 +26,39 @@ import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
 
 public interface NetworkCmProxyCmHandleQueryService {
     /**
-     * Query and return cm handles that match the given query parameters.
+     * Query and return cm handle ids that match the given query parameters.
+     * Supported query types:
+     *      public properties
+     *      modules
+     *      cps-path
      *
      * @param cmHandleQueryServiceParameters the cm handle query parameters
-     * @return collection of cm handles
+     * @return collection of cm handle ids
      */
-    Collection<NcmpServiceCmHandle> queryCmHandles(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
+    Collection<String> queryCmHandleIds(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
 
     /**
-     * Query and return cm handles that match the given query parameters.
+     * Query and return cm handle ids that match the given query parameters.
+     * Supported query types:
+     *      public properties
+     *      private (additional) properties
+     *      dmi-names
+     * The inventory interface also allows conditions on private (additional) properties and dmi names
      *
      * @param cmHandleQueryServiceParameters the cm handle query parameters
      * @return collection of cm handle ids
      */
-    Collection<String> queryCmHandleIds(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
+    Collection<String> queryCmHandleIdsForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
 
     /**
-     * Query and return cm handles that match the given query parameters.
+     * Query and return cm handle objects that match the given query parameters.
+     * Supported query types:
+     *      public properties
+     *      modules
+     *      cps-path
      *
      * @param cmHandleQueryServiceParameters the cm handle query parameters
-     * @return collection of cm handle ids
+     * @return collection of cm handles
      */
-    Collection<String> queryCmHandleIdsForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
+    Collection<NcmpServiceCmHandle> queryCmHandles(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
 }
-- 
cgit 1.2.3-korg