aboutsummaryrefslogtreecommitdiffstats
path: root/aai-annotations/src/main/java/org/onap/aai/schema/enums/ObjectMetadata.java
blob: 406800fda5809b215844438efdda3d9fd55d5251 (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
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 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.onap.aai.schema.enums;

public enum ObjectMetadata {

    /**
     * description of object
     */
    DESCRIPTION("description"),
    /**
     * names of properties to appear in relationship-lists
     * and parent objects in DMaaP messages
     * <br>
     * <b>comma separated list</b>
     */
    NAME_PROPS("nameProps"),
    /**
     * names of properties to be indexed in the
     * db schema
     * <br>
     * <b>comma separated list</b>
     */
    INDEXED_PROPS("indexedProps"),
    /**
     * name of the object this one depends on
     */
    DEPENDENT_ON("dependentOn"),
    /**
     * name of the object which contains this object
     */
    CONTAINER("container"),
    /**
     * the top level namespace to which this object belongs<br>
     * <b>only valid on top level objects</b>
     */
    NAMESPACE("namespace"),
    /**
     * properties which are searchable via the GUI
     * <br>
     * <b>comma separated list</b>
     */
    SEARCHABLE("searchable"),
    /**
     * properties marked as unique in the db schema
     * <br>
     * <b>comma separated list</b>
     */
    UNIQUE_PROPS("uniqueProps"),
    /**
     * properties marked as required
     * <br>
     * <b>comma separated list</b>
     */
    REQUIRED_PROPS("requiredProps"),
    /**
     * uri template for this object
     */
    URI_TEMPLATE("uriTemplate"),
    /**
     * abstract type from which this object extends
     */
    EXTENDS("extends"),
    /**
     * comma separated list of objects who inherit this object<br>
     * <b>only valid on abstract objects</b>
     */
    INHERITORS("inheritors"),
    /**
     * a value of true marks this object as abstract
     * abstract objects cannot be read/written directly
     * they resolve to "or queries" when used in queries
     */
    ABSTRACT("abstract"),
    /**
     * comma separated list of properties which are alternate ways
     * to identify this object
     */
    ALTERNATE_KEYS_1("alternateKeys1"),
    /**
     * the maximum allowable retrievable depth
     */
    MAXIMUM_DEPTH("maximumDepth"),
    /**
     * collection of other objects to retrieve along with this one
     * <br>
     * <b>comma separated list</b>
     */
    CROSS_ENTITY_REFERENCE("crossEntityReference"),
    /**
     * Marks that this object can be linked to via dataLink
     */
    CAN_BE_LINKED("canBeLinked"),
    /**
     * The entity contains properties that are suggestible
     */
    CONTAINS_SUGGESTIBLE_PROPS("containsSuggestibleProps"),
    /**
     * A list of aliases for the entity name (for AAI UI searches)
     */
    SUGGESTION_ALIASES("suggestionAliases"),
    /**
     * a value of true allows this object to be read directly
     */
    ALLOW_DIRECT_READ("allowDirectRead"),
    /**
     * a value of true allows this object to be written directly
     */
    ALLOW_DIRECT_WRITE("allowDirectWrite"),
    /**
     * properties that are allowed to be in start node in a DSL
     * <br>
     * <b>comma separated list</b>
     */
    DSL_START_NODE_PROPS("dslStartNodeProps");

    private final String name;

    private ObjectMetadata(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return name;
    }

}