cps-ri/src/main/java/org/onap/cps/spi/repository/ModuleReferenceQuery.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 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.spi.repository;
  22
  23 import java.util.Collection;
  24 import java.util.Set;
  25 import org.onap.cps.spi.model.CmHandleQueryParameters;
  26 import org.onap.cps.spi.model.ModuleReference;
  27
  28 /**
  29  * This interface is used in conjunction with {@link ModuleReferenceRepository} to create native sql queries.
  30  */
  31 public interface ModuleReferenceQuery {
  32
  33     Collection<ModuleReference> identifyNewModuleReferences(
  34         final Collection<ModuleReference> moduleReferencesToCheck);
  35
  36     /**
  37      * Query and return cm handles that match the given query parameters.
  38      *
  39      * @param cmHandleQueryParameters the cm handle query parameters
  40      * @return collection of cm handle ids
  41      */
  42     Set<String> queryCmHandles(CmHandleQueryParameters cmHandleQueryParameters);
  43
  44 }