catalog-be/src/main/java/org/openecomp/sdc/be/components/attribute/AttributeDeclarator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2021, Nordix Foundation. 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
  21 package org.openecomp.sdc.be.components.attribute;
  22
  23 import fj.data.Either;
  24 import java.util.List;
  25 import org.openecomp.sdc.be.model.Component;
  26 import org.openecomp.sdc.be.model.ComponentInstanceAttribOutput;
  27 import org.openecomp.sdc.be.model.OutputDefinition;
  28 import org.openecomp.sdc.be.model.operations.api.StorageOperationStatus;
  29
  30 public interface AttributeDeclarator {
  31
  32     /**
  33      * creates a list of outputs from the given list of attributes and updates the attributes accordingly
  34      *
  35      * @param component         the container
  36      * @param propertiesOwnerId the id of the owner of the attributes to declare (e.g ComponentInstance, Policy, Group
  37      *                          etc)
  38      * @param attribsToDeclare    the list of attributes that are being declared as outputs
  39      * @return the list of outputs that were created from the given attributes
  40      */
  41     Either<List<OutputDefinition>, StorageOperationStatus> declareAttributesAsOutputs(final Component component,
  42                                                                                       final String propertiesOwnerId,
  43                                                                                       final List<ComponentInstanceAttribOutput> attribsToDeclare);
  44
  45     /**
  46      * returns the values of declared attributes to each original state before it was declared as an input. this
  47      * function is to be called when an input, that was created by declaring a property, is deleted.
  48      *
  49      * @param component the container of the input to be deleted
  50      * @param output     the input to be deleted
  51      */
  52     StorageOperationStatus unDeclareAttributesAsOutputs(final Component component, final OutputDefinition output);
  53 }