summaryrefslogtreecommitdiffstats
path: root/catalog-model/src/main/java/org/openecomp/sdc/be/model/operations/api/IPropertyOperation.java
blob: 6309510f6d2bf81a3b10e851a35a492ae169253d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.sdc.be.model.operations.api;

import java.util.Map;

import org.apache.commons.lang3.tuple.ImmutablePair;
import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
import org.openecomp.sdc.be.model.DataTypeDefinition;
import org.openecomp.sdc.be.model.IComplexDefaultValue;
import org.openecomp.sdc.be.model.PropertyDefinition;

import fj.data.Either;

public interface IPropertyOperation {

	/**
	 * add property to resource
	 * 
	 * @param propertyName
	 * @param propertyDefinition
	 * @param nodeType
	 * @param id
	 * @return
	 * 
	 * 		public Either<PropertyDefinition, StorageOperationStatus>
	 *         addPropertyToResource( String propertyName, PropertyDefinition
	 *         propertyDefinition, NodeTypeEnum nodeType, String id);
	 */

	/**
	 * get property belongs to resource
	 * 
	 * @param propertyName
	 *            - property name
	 * @param resourceId
	 *            - resource unique id
	 * @return
	 */
	public Either<PropertyDefinition, StorageOperationStatus> getPropertyOfResource(String propertyName,
			String resourceId);

	/**
	 * Delete all properties of resource
	 * 
	 * @param nodeType
	 * @param uniqueId
	 * @return
	 */
	public Either<Map<String, PropertyDefinition>, StorageOperationStatus> deleteAllPropertiesAssociatedToNode(
			NodeTypeEnum nodeType, String uniqueId);

	public boolean isPropertyDefaultValueValid(IComplexDefaultValue propertyDefinition,
			Map<String, DataTypeDefinition> dataTypes);

	public boolean isPropertyTypeValid(IComplexDefaultValue propertyDefinition);

	public ImmutablePair<String, Boolean> isPropertyInnerTypeValid(IComplexDefaultValue propertyDefinition,
			Map<String, DataTypeDefinition> dataTypes);

	/**
	 * @param dataTypeDefinition
	 * @return
	 */
	public Either<DataTypeDefinition, StorageOperationStatus> addDataType(DataTypeDefinition dataTypeDefinition);

	public Either<DataTypeDefinition, StorageOperationStatus> addDataType(DataTypeDefinition dataTypeDefinition,
			boolean inTransaction);

	/**
	 * @param name
	 * @return
	 */
	public Either<DataTypeDefinition, StorageOperationStatus> getDataTypeByName(String name);

	public Either<DataTypeDefinition, StorageOperationStatus> getDataTypeByName(String name, boolean inTransaction);

	public Either<DataTypeDefinition, StorageOperationStatus> getDataTypeByNameWithoutDerived(String name,
			boolean inTransaction);

	public Either<DataTypeDefinition, StorageOperationStatus> getDataTypeByNameWithoutDerived(String name);

	public StorageOperationStatus validateAndUpdateProperty(IComplexDefaultValue propertyDefinition,
			Map<String, DataTypeDefinition> dataTypes);

	public Either<DataTypeDefinition, StorageOperationStatus> updateDataType(DataTypeDefinition newDataTypeDefinition,
			DataTypeDefinition oldDataTypeDefinition, boolean inTransaction);

	public Either<DataTypeDefinition, StorageOperationStatus> updateDataType(DataTypeDefinition newDataTypeDefinition,
			DataTypeDefinition oldDataTypeDefinition);

}