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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2023 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 handles that match the given query parameters.
  30      *
  31      * @param cmHandleQueryServiceParameters the cm handle query parameters
  32      * @return collection of cm handles
  33      */
  34     Collection<NcmpServiceCmHandle> queryCmHandles(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
  35
  36     /**
  37      * Query and return cm handles that match the given query parameters.
  38      *
  39      * @param cmHandleQueryServiceParameters the cm handle query parameters
  40      * @return collection of cm handle ids
  41      */
  42     Collection<String> queryCmHandleIds(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
  43
  44     /**
  45      * Query and return cm handles that match the given query parameters.
  46      *
  47      * @param cmHandleQueryServiceParameters the cm handle query parameters
  48      * @return collection of cm handle ids
  49      */
  50     Collection<String> queryCmHandleIdsForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
  51 }