aboutsummaryrefslogtreecommitdiffstats
path: root/PolicyEngineAPI/src/main/java/org/openecomp/policy/api/ImportParameters.java
blob: 299f29a935ee3bedd4c713218874c4b2be162d3c (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*-
 * ============LICENSE_START=======================================================
 * PolicyEngineAPI
 * ================================================================================
 * 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.policy.api;

import java.util.List;
import java.util.UUID;


/**
 * <code>ImportParameters</code> defines the Policy Engine Import Parameters
 *  which are required to import a new Policy Service or Value. 
 * 
 * @version 0.1
 */
public class ImportParameters {
	private String serviceName;
	private String description;
	private UUID requestID;
	private String filePath;
	private String importBody;
	private String version;
	private IMPORT_TYPE importType;
	
	public enum IMPORT_TYPE {
	    MICROSERVICE
	}

	/**
	 * Sets Import Policy Parameters.
	 * 
	 * @param serviceName the <code>String</code> format of the Service Name
	 * @param description the <code>String</code> format of the i Description
	 * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
	 * @param filePath the <code>List</code> format of the file paths for the service files
	 * @param importType the {@link IMPORT_TYPE} format of the Policy Service List
	 * @param version the <code>String</code> format of the Policy Import Version
	 * A different request ID should be passed for each request.
	 */
	public void setImportParameters(String serviceName, String description, UUID requestID, String filePath, IMPORT_TYPE importType, String version){
		
		this.setServiceName(serviceName);
		this.setDescription(description);
		this.setRequestID(requestID);
		this.setFilePath(filePath);
		this.setServiceType(importType);	
		this.setVersion(version);
		
	}

	/**
	 * Gets the Policy Service of the Policy Service Import Parameters. 
	 * 
	 * @return serviceName the <code>String</code> format of the Policy Service Name
	 */
	public String getServiceName() {
		return serviceName;
	}

	/**
	 * Sets the serviceName of the Policy Service Parameters.
	 * 
	 * @param serviceName the <code>String</code> format of the Policy Service Name
	 */
	public void setServiceName(String serviceName) {
		this.serviceName = serviceName;
	}

	/**
	 * Gets the Policy Import Description. 
	 * 
	 * @return description the <code>String</code> format of the Policy Import Description
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * Sets the Description of the new Policy Import Description. 
	 * 
	 * @param description the <code>String</code> format of the Policy Import Description
	 */
	public void setDescription(String description) {
		this.description = description;
	}
	
	/**
	 * Gets the requestID of the Policy Parameters. 
	 * 
	 * @return unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
	 */
	public UUID getRequestID() {
		return requestID;
	}
	
	/**
	 * Sets the requestID of the Policy Parameters. 
	 * 
	 * @param requestID unique request ID which will be passed throughout the ECOMP components to correlate logging messages.
	 */
	public void setRequestID(UUID requestID) {
		this.requestID = requestID;
	}

	/**
	 * Gets the importBody of the new policy import. 
	 * 
	 * @return importBody the <code>String</code> format of the Policy Import Body
	 */
	public String getImportBody() {
		return importBody;
	}

	/**
	 * Sets the importBody of the Policy Import Body. 
	 * 
	 * @param importBody the <code>String</code> format of the Policy Import Body
	 */
	public void setImportBody(String importBody) {
		this.importBody = importBody;
	}
	
	/**
	 * Gets the List of File Paths of the new import. 
	 * 
	 * @return filePath the <code>List</code> format of the Policy Import  File
	 */
	public String getFilePath() {
		return filePath;
	}

	/**
	 * Sets the policy Import File List of the new Policy Import. 
	 * 
	 * @param filePath the <code>List</code> format of the Policy Import  File
	 */
	public void setFilePath(String filePath) {
		this.filePath = filePath;
	}
	
	/** 
	 * Gets the Service Type of the new policy import. 
	 * 
	 * @return ImportType {@link IMPORT_TYPE} format of the Policy Service List
	 */
	public IMPORT_TYPE getServiceType() {
		return importType;
	}
	
	/**
	 * Sets the policy Service Type of the new Policy Service. 
	 * 
	 * @param enumImportType the <code>enumServiceType</code> format of the Policy Service List
	 */
	public void setServiceType(IMPORT_TYPE enumImportType) {
		this.importType = enumImportType;
	}
	
	/**
	 * 
	 * Gets the Import Version of the new policy import. 
	 * 
	 * @return version the <code>String</code> format of the Policy Import Version
	 */
	public String getVersion() {
		return version;
	}

	/**
	 * Sets the policy Import Version  of the new Policy Import. 
	 * 
	 * @param version the <code>String</code> format of the Policy Import Version
	 */
	public void setVersion(String version) {
		this.version = version;
	}
}