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