Update the license for 2017-2018 license
[aai/aai-common.git] / aai-schema / src / main / java / org / onap / aai / schema / enums / PropertyMetadata.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright © 2017-2018 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 package org.onap.aai.schema.enums;
21
22 public enum PropertyMetadata {
23
24         /**
25          * description of property
26          */
27         DESCRIPTION("description"),
28         /**
29          * default value of property
30          */
31         DEFAULT_VALUE("defaultValue"),
32         /**
33          * sets the property name used when writing to the db
34          */
35         DB_ALIAS("dbAlias"),
36         /**
37          * a URI which describes the location of a value to be
38          * written on a PUT
39          */
40         DATA_COPY("dataCopy"),
41         /**
42          * a URI which describes another object which backs this value
43          */
44         DATA_LINK("dataLink"),
45         /**
46          * controls the visibility of a field based on context
47          */
48         VISIBILITY("visibility"),
49         /**
50          * specifies a field which must be populated to pass validation
51          */
52         REQUIRES("requires"),
53         /**
54          * automatically creates an id for the property if not specified
55          */
56         AUTO_GENERATE_UUID("autoGenerateUuid"),
57         /**
58          * Property is used for VNF searches in AAI UI
59          */
60         SUGGESTIBLE_ON_SEARCH("suggestibleOnSearch"),
61         /**
62          * An identifier that indicates which system is the master of this property data
63          */
64         SOURCE_OF_TRUTH_TYPE("sourceOfTruthType"),
65         /**
66          * makes property read only by version
67          */
68         READ_ONLY("readOnly");
69         
70          private final String name;
71
72           private PropertyMetadata(String name) { 
73             this.name = name;
74           }
75
76           @Override public String toString() {
77             return name; 
78           }
79 }