catalog-be/src/main/java/org/openecomp/sdc/be/components/merge/ComponentsMergeCommand.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.openecomp.sdc.be.components.merge;
  21
  22 import org.openecomp.sdc.be.dao.api.ActionStatus;
  23 import org.openecomp.sdc.be.model.Component;
  24
  25 public interface ComponentsMergeCommand {
  26
  27     /**
  28      * encapsulates the logic of merging component inner entities from the previous component into the currently updated component
  29      *
  30      * @param prevComponent    the old component, whose entities need to be merged
  31      * @param currentComponent the new component, whose entities need to be merged
  32      * @return the status of the merge process
  33      */
  34     ActionStatus mergeComponents(Component prevComponent, Component currentComponent);
  35
  36     /**
  37      * @return short description of the command for logging purposes
  38      */
  39     String description();
  40 }