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
|
/*-
* ============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 org.openecomp.sdc.be.resources.data.ConsumerData;
import fj.data.Either;
public interface IConsumerOperation {
/**
* the method updates the node in the graph with the given ConsumerData
*
* @param consumerData
* the object we want to store
* @param inTransaction
* inTransaction is the operation part of a transaction, in case the value is false the action will be committed in the end of the method
* @return the updated object returned from the graph
*/
Either<ConsumerData, StorageOperationStatus> updateCredentials(ConsumerData consumerData, boolean inTransaction);
/**
* the method updates the node in the graph with the given ConsumerData
*
* @param consumerData
* the object we want to store
* @return the updated object returned from the graph
*/
Either<ConsumerData, StorageOperationStatus> updateCredentials(ConsumerData consumerData);
/**
* the method deletes the node with the given unique id
*
* @param consumerName
* the unique id by witch we will look up the credential we want to delete
* @param inTransaction
* inTransaction is the operation part of a transaction, in case the value is false the action will be committed in the end of the method
* @return the deleted object returned from the graph
*/
Either<ConsumerData, StorageOperationStatus> deleteCredentials(String consumerName, boolean inTransaction);
/**
* the method deletes the node with the given unique id
*
* @param consumerName
* the unique id by witch we will look up the credential we want to delete
* @return the deleted object returned from the graph
*/
Either<ConsumerData, StorageOperationStatus> deleteCredentials(String consumerName);
/**
* the method creates a new nod in the grape representing the supplied credential object
*
* @param consumerData
* the object we want to store
* @param inTransaction
* is the operation part of a transaction, in case the value is false the action will be committed in the end of the method
* @return the newly stored object returned from the graph
*/
Either<ConsumerData, StorageOperationStatus> createCredentials(ConsumerData consumerData, boolean inTransaction);
/**
* the method creates a new nod in the grape representing the supplied credential object
*
* @param consumerData
* the object we want to store
* @return the newly stored object returned from the graph
*/
Either<ConsumerData, StorageOperationStatus> createCredentials(ConsumerData consumerData);
/**
* the method retrieves the credential for the given consumer name
*
* @param consumerName
* the unique id by witch we will look up the credential
* @return ConsumerData or the error received during the operation
*/
Either<ConsumerData, StorageOperationStatus> getCredentials(String consumerName);
/**
*
* @return all consumers
*/
Either<List<ConsumerData>, StorageOperationStatus> getAll();
}
|
