summaryrefslogtreecommitdiffstats
path: root/cps-ncmp-service/src
diff options
context:
space:
mode:
authorseanbeirne <sean.beirne@est.tech>2023-03-06 09:12:49 +0000
committerSean Beirne <sean.beirne@est.tech>2023-03-22 16:29:11 +0000
commitf5a3a2177ee328ac842883a89c75169c9a651f53 (patch)
tree94b53823190e0645291037d649b6e3628f4a40ec /cps-ncmp-service/src
parentaa3b2d66f489528e7773e2db584d41807dadfcb0 (diff)
NCMP Inventory documentation update
- Updated release notes Issue-ID: CPS-1494 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: I43fc285da9d6699326d5e0a933fdb3c5c7abcb12
Diffstat (limited to 'cps-ncmp-service/src')
-rw-r--r--cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandleQueryService.java29
1 files changed, 21 insertions, 8 deletions
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 91e98e866b..f29fd687b0 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);
}