[AAI-12] Add the swagger documentation for onap
[aai/aai-common.git] / aai-core / src / main / java / org / openecomp / aai / util / swagger / Definition.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * org.openecomp.aai
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.aai.util.swagger;
22
23 import java.util.List;
24
25 public class Definition {
26
27     private String definitionName;
28
29     private String definitionDescription;
30
31     private List<Property> propertyList;
32
33     private List<Property> schemaPropertyList;
34
35     private List<Property> regularPropertyList;
36
37     private boolean hasDescription;
38
39     public String getDefinitionName() {
40         return definitionName;
41     }
42
43     public void setDefinitionName(String definitionName) {
44         this.definitionName = definitionName;
45     }
46
47     public List<Property> getPropertyList() {
48         return propertyList;
49     }
50
51     public void setPropertyList(List<Property> propertyList) {
52         this.propertyList = propertyList;
53     }
54
55     public String getDefinitionDescription() {
56         return definitionDescription;
57     }
58
59     public void setDefinitionDescription(String definitionDescription) {
60         this.definitionDescription = definitionDescription;
61     }
62
63     @Override
64     public String toString() {
65         return "Definition{" +
66                 "definitionName='" + definitionName + '\'' +
67                 ", definitionDescription='" + definitionDescription + '\'' +
68                 ", propertyList=" + propertyList +
69                 '}';
70     }
71
72     public boolean isHasDescription() {
73         return hasDescription;
74     }
75
76     public void setHasDescription(boolean hasDescription) {
77         this.hasDescription = hasDescription;
78     }
79
80     public List<Property> getSchemaPropertyList() {
81         return schemaPropertyList;
82     }
83
84     public void setSchemaPropertyList(List<Property> schemaPropertyList) {
85         this.schemaPropertyList = schemaPropertyList;
86     }
87
88     public List<Property> getRegularPropertyList() {
89         return regularPropertyList;
90     }
91
92     public void setRegularPropertyList(List<Property> regularPropertyList) {
93         this.regularPropertyList = regularPropertyList;
94     }
95
96     public static class Property {
97
98         private String propertyName;
99
100         private String propertyDescription;
101
102         private boolean hasPropertyDescription;
103
104         private String propertyType;
105
106         private boolean hasType;
107
108         private String propertyReference;
109
110         private String propertyReferenceObjectName;
111
112         private boolean isRequired;
113
114         private boolean hasPropertyReference;
115
116         public Property(){}
117
118         public String getPropertyName() {
119             return propertyName;
120         }
121
122         public void setPropertyName(String propertyName) {
123             this.propertyName = propertyName;
124         }
125
126         public String getPropertyType() {
127             return propertyType;
128         }
129
130         public void setPropertyType(String propertyType) {
131             this.propertyType = propertyType;
132         }
133
134         public String getPropertyReference() {
135             return propertyReference;
136         }
137
138         public void setPropertyReference(String propertyReference) {
139             this.propertyReference = propertyReference;
140         }
141
142         @Override
143         public String toString() {
144             return "Property{" +
145                     "propertyName='" + propertyName + '\'' +
146                     ", propertyType='" + propertyType + '\'' +
147                     ", propertyReference='" + propertyReference + '\'' +
148                     '}';
149         }
150
151         public boolean isHasType() {
152             return hasType;
153         }
154
155         public void setHasType(boolean hasType) {
156             this.hasType = hasType;
157         }
158
159         public boolean isRequired() {
160             return isRequired;
161         }
162
163         public void setRequired(boolean required) {
164             isRequired = required;
165         }
166
167         public boolean isHasPropertyReference() {
168             return hasPropertyReference;
169         }
170
171         public void setHasPropertyReference(boolean hasPropertyReference) {
172             this.hasPropertyReference = hasPropertyReference;
173         }
174
175         public String getPropertyReferenceObjectName() {
176             return propertyReferenceObjectName;
177         }
178
179         public void setPropertyReferenceObjectName(String propertyReferenceObjectName) {
180             this.propertyReferenceObjectName = propertyReferenceObjectName;
181         }
182
183         public String getPropertyDescription() {
184             return propertyDescription;
185         }
186
187         public void setPropertyDescription(String propertyDescription) {
188             this.propertyDescription = propertyDescription;
189         }
190
191         public boolean isHasPropertyDescription() {
192             return hasPropertyDescription;
193         }
194
195         public void setHasPropertyDescription(boolean hasPropertyDescription) {
196             this.hasPropertyDescription = hasPropertyDescription;
197         }
198     }
199 }