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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.api;
23 import java.util.Collection;
24 import org.onap.cps.ncmp.api.models.CmHandleQueryServiceParameters;
25 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
27 public interface NetworkCmProxyCmHandleQueryService {
29 * Query and return cm handle ids that match the given query parameters.
30 * Supported query types:
35 * @param cmHandleQueryServiceParameters the cm handle query parameters
36 * @return collection of cm handle ids
38 Collection<String> queryCmHandleIds(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
41 * Query and return cm handle ids that match the given query parameters.
42 * Supported query types:
44 * private (additional) properties
46 * The inventory interface also allows conditions on private (additional) properties and dmi names
48 * @param cmHandleQueryServiceParameters the cm handle query parameters
49 * @return collection of cm handle ids
51 Collection<String> queryCmHandleIdsForInventory(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);
54 * Query and return cm handle objects that match the given query parameters.
55 * Supported query types:
60 * @param cmHandleQueryServiceParameters the cm handle query parameters
61 * @return collection of cm handles
63 Collection<NcmpServiceCmHandle> queryCmHandles(CmHandleQueryServiceParameters cmHandleQueryServiceParameters);