catalog-model/src/main/java/org/openecomp/sdc/be/model/operations/api/IPropertyOperation.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 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
  21 package org.openecomp.sdc.be.model.operations.api;
  22
  23 import fj.data.Either;
  24 import org.apache.commons.lang3.tuple.ImmutablePair;
  25 import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
  26 import org.openecomp.sdc.be.model.DataTypeDefinition;
  27 import org.openecomp.sdc.be.model.IComplexDefaultValue;
  28 import org.openecomp.sdc.be.model.PropertyDefinition;
  29
  30 import java.util.Map;
  31
  32 public interface IPropertyOperation {
  33
  34         /**
  35          * Delete all properties of resource
  36          *
  37          * @param nodeType
  38          * @param uniqueId
  39          * @return
  40          */
  41         public Either<Map<String, PropertyDefinition>, StorageOperationStatus> deleteAllPropertiesAssociatedToNode(NodeTypeEnum nodeType, String uniqueId);
  42
  43         /**
  44          * same as deleteAllPropertiesAssociatedToNode but returns empty map if node has no properties
  45          * @param nodeType
  46          * @param uniqueId
  47          * @return
  48          */
  49         Either<Map<String, PropertyDefinition>, StorageOperationStatus> deletePropertiesAssociatedToNode(NodeTypeEnum nodeType, String uniqueId);
  50
  51         public boolean isPropertyDefaultValueValid(IComplexDefaultValue propertyDefinition, Map<String, DataTypeDefinition> dataTypes);
  52
  53         public boolean isPropertyTypeValid(IComplexDefaultValue propertyDefinition);
  54
  55         public ImmutablePair<String, Boolean> isPropertyInnerTypeValid(IComplexDefaultValue propertyDefinition, Map<String, DataTypeDefinition> dataTypes);
  56
  57         /**
  58          * @param dataTypeDefinition
  59          * @return
  60          */
  61         public Either<DataTypeDefinition, StorageOperationStatus> addDataType(DataTypeDefinition dataTypeDefinition);
  62
  63         /**
  64          * @param name
  65          * @return
  66          */
  67         public Either<DataTypeDefinition, StorageOperationStatus> getDataTypeByName(String name);
  68
  69         public Either<DataTypeDefinition, StorageOperationStatus> getDataTypeByName(String name, boolean inTransaction);
  70
  71         public Either<DataTypeDefinition, StorageOperationStatus> getDataTypeByNameWithoutDerived(String name);
  72
  73         public StorageOperationStatus validateAndUpdateProperty(IComplexDefaultValue propertyDefinition, Map<String, DataTypeDefinition> dataTypes);
  74
  75         public Either<DataTypeDefinition, StorageOperationStatus> updateDataType(DataTypeDefinition newDataTypeDefinition, DataTypeDefinition oldDataTypeDefinition);
  76
  77 }