aboutsummaryrefslogtreecommitdiffstats
path: root/catalog-model/src/main/java/org/openecomp/sdc/be/model/operations/api/IResourceOperation.java
blob: 01db3a5105e9b9d98941aad8a50ef418a9c6172b (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*-
 * ============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.List;
import java.util.Map;
import java.util.Set;

import org.openecomp.sdc.be.dao.titan.TitanGenericDao;
import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
import org.openecomp.sdc.be.model.LifecycleStateEnum;
import org.openecomp.sdc.be.model.Resource;

import fj.data.Either;

public interface IResourceOperation extends IComponentOperation {

	public TitanGenericDao getTitanGenericDao();

	// public StorageOperationStatus lockResource(Resource resource);
	//
	// public StorageOperationStatus unlockResource(Resource resource);

	public Either<Resource, StorageOperationStatus> createResource(Resource resource);

	public Either<Resource, StorageOperationStatus> createResource(Resource resource, boolean inTransaction);

	public Either<Resource, StorageOperationStatus> getResource(String resourceId);

	// public Either<Resource, StorageOperationStatus> getResource_tx(String
	// resourceId,boolean inTransaction);

	public Either<Resource, StorageOperationStatus> getResource(String resourceId, boolean inTransaction);

	/**
	 * the method retrieves all the certified resources, the returned values are only abstract or only none abstract according to the supplied parameters.
	 * 
	 * @param getAbstract
	 *            the value defines which resources to return only abstract or only none abstract
	 * @return
	 */
	public Either<List<Resource>, StorageOperationStatus> getAllCertifiedResources(boolean getAbstract);

	public Either<List<Resource>, StorageOperationStatus> getAllCertifiedResources(boolean getAbstract, Boolean isHighest);

	public Either<Boolean, StorageOperationStatus> validateResourceNameExists(String resourceName, ResourceTypeEnum resourceType);

	public Either<Resource, StorageOperationStatus> deleteResource(String resourceId);

	public Either<Resource, StorageOperationStatus> deleteResource(String resourceId, boolean inTransaction);

	public Either<Resource, StorageOperationStatus> updateResource(Resource resource);

	public Either<Resource, StorageOperationStatus> updateResource(Resource resource, boolean inTransaction);

	public Either<Integer, StorageOperationStatus> getNumberOfResourcesByName(String resourceName);

	// public Either<List<ArtifactDefinition>, StorageOperationStatus>
	// getResourceArtifactsForDelete(Resource resource);

	public Either<List<Resource>, StorageOperationStatus> getFollowed(String userId, Set<LifecycleStateEnum> lifecycleStates, Set<LifecycleStateEnum> lastStateStates, boolean inTransaction);

	public Either<Set<Resource>, StorageOperationStatus> getCatalogData(Map<String, Object> propertiesToMatch, boolean inTransaction);

	public Either<Resource, StorageOperationStatus> getLatestByName(String resourceName, boolean inTransaction);

	public Either<Resource, StorageOperationStatus> overrideResource(Resource resource, Resource resourceSaved, boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getTesterFollowed(String userId, Set<LifecycleStateEnum> lifecycleStates, boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getResourceListByUuid(String uuid, boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getLatestResourceByUuid(String uuid, boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getResourceListBySystemName(String systemName, boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getResourceCatalogData(boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getResourceCatalogDataVFLatestCertifiedAndNonCertified(boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getResourceByNameAndVersion(String name, String version, boolean inTransaction);

	public Either<List<Resource>, StorageOperationStatus> getResourceByNameAndVersion(String name, String version);

	public Either<Resource, StorageOperationStatus> getResourceBySystemNameAndVersion(String name, String version, Map<String, Object> additionalParams, boolean inTransaction);

	// public Either<List<Resource>, StorageOperationStatus>
	// getAllNotCheckoutResources(boolean getAbstract);

	// public Either<List<Resource>, StorageOperationStatus>
	// getAllNotCheckoutResources(boolean getAbstract, Boolean isHighest);

	public Either<List<String>, StorageOperationStatus> getAllResourcesMarkedForDeletion();

	public Either<Boolean, StorageOperationStatus> isResourceInUse(String resourceToDelete);

	public Either<Resource, StorageOperationStatus> getLatestByToscaResourceName(String toscaResourceName, boolean inTransaction);

	public Either<Boolean, StorageOperationStatus> validateToscaResourceNameExists(String templateName);
	
	public Either<Boolean, StorageOperationStatus> validateToscaResourceNameExtends(String templateNameCurrent, String templateNameExtends);

	/**
	 *
	 * @param resource the resource to look for its derived resources
	 * @return all resources which derives from the given resource
	 */
	Either<List<Resource>, StorageOperationStatus> getAllDerivedResources(Resource resource);

	/**
	 *
	 * @return all root resources (i.e all normatives with tosca name {@code Resource.ROOT_RESOURCE}
	 */
	Either<List<Resource>, StorageOperationStatus> getRootResources();

	/**
	 *
	 * @return all resources with type VF
	 */
	Either<List<Resource>, StorageOperationStatus> getVFResources();

	/**
	 *
	 * @return all resources
	 */
	Either<List<Resource>, StorageOperationStatus> getAll();

}