Agree LCM Event Schema(s)
[cps.git] / cps-ncmp-service / src / main / java / org / onap / cps / ncmp / api / impl / event / NcmpEventsCmHandleStateHandler.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.ncmp.api.impl.event;
22
23 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
24 import org.onap.cps.ncmp.api.inventory.CmHandleState;
25
26 /**
27  * The implementation of it should handle the persisting of composite state and delegate the request to publish the
28  * corresponding ncmp event.
29  */
30 public interface NcmpEventsCmHandleStateHandler {
31
32     /**
33      * Updates the composite state of cmHandle based on cmHandleState.
34      *
35      * @param yangModelCmHandle   cm handle represented as yang model
36      * @param targetCmHandleState target cm handle state
37      */
38     void updateCmHandleState(final YangModelCmHandle yangModelCmHandle, final CmHandleState targetCmHandleState);
39 }