gerrit.onap Code Review - cps.git/blob

   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.impl.inventory;
  22
  23 import java.util.Collection;
  24 import org.onap.cps.ncmp.api.inventory.models.CmHandleQueryServiceParameters;
  25 import org.onap.cps.ncmp.api.inventory.models.NcmpServiceCmHandle;
  26
  27 public interface ParameterizedCmHandleQueryService {
  28     /**
  29      * Query and return cm handle ids or alternate 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      * @param outputAlternateId Boolean for cm handle reference type either
  37      *                            cm handle id (false or null) or alternate id (true)
  38      * @return collection of cm handle ids or alternate ids
  39      */
  40     Collection<String> queryCmHandleReferenceIds(CmHandleQueryServiceParameters cmHandleQueryServiceParameters,
  41                                                  boolean outputAlternateId);
  42
  43     /**
  44      * Query and return cm handle ids or alternate ids that match the given query parameters.
  45      * Supported query types:
  46      *      public properties
  47      *      private (additional) properties
  48      *      dmi-names
  49      * The inventory interface also allows conditions on private (additional) properties and dmi names
  50      *
  51      * @param cmHandleQueryServiceParameters the cm handle query parameters
  52      * @param outputAlternateId Boolean for cm handle reference type either
  53      *                            cm handle id (false or null) or alternate id (true)
  54      * @return collection of cm handle ids
  55      */
  56     Collection<String> queryCmHandleIdsForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters,
  57                                                     boolean outputAlternateId);
  58
  59     /**
  60      * Query and return cm handle objects that match the given query parameters.
  61      * Supported query types:
  62      *      public properties
  63      *      modules
  64      *      cps-path
  65      *
  66      * @param cmHandleQueryServiceParameters the cm handle query parameters
  67      * @return collection of cm handles
  68      */
  69     Collection<NcmpServiceCmHandle> queryCmHandles(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
  70
  71     /**
  72      * Get all cm handle objects.
  73      * Note: it is similar to all the queries above but simply no conditions and hence not 'parameterized'
  74      *
  75      * @return collection of cm handles
  76      */
  77     Collection<NcmpServiceCmHandle> getAllCmHandles();
  78 }