cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyCmHandleQueryService.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2024 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
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.api;
  22
  23 import java.util.Collection;
  24 import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
  25 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  26
  27 public interface NetworkCmProxyCmHandleQueryService {
  28     /**
  29      * Query and return cm handle ids that match the given query parameters.
  30      * Supported query types:
  31      *      public properties
  32      *      modules
  33      *      cps-path
  34      *
  35      * @param cmHandleQueryServiceParameters the cm handle query parameters
  36      * @return collection of cm handle ids
  37      */
  38     Collection<String> queryCmHandleIds(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
  39
  40     /**
  41      * Query and return cm handle ids that match the given query parameters.
  42      * Supported query types:
  43      *      public properties
  44      *      private (additional) properties
  45      *      dmi-names
  46      * The inventory interface also allows conditions on private (additional) properties and dmi names
  47      *
  48      * @param cmHandleQueryServiceParameters the cm handle query parameters
  49      * @return collection of cm handle ids
  50      */
  51     Collection<String> queryCmHandleIdsForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
  52
  53     /**
  54      * Query and return cm handle objects that match the given query parameters.
  55      * Supported query types:
  56      *      public properties
  57      *      modules
  58      *      cps-path
  59      *
  60      * @param cmHandleQueryServiceParameters the cm handle query parameters
  61      * @return collection of cm handles
  62      */
  63     Collection<NcmpServiceCmHandle> queryCmHandles(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
  64
  65     /**
  66      * Query and return all cm handle objects.
  67      *
  68      * @return collection of cm handles
  69      */
  70     Collection<NcmpServiceCmHandle> getAllCmHandles();
  71 }