2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.aai.schema.enums;
23 public enum ObjectMetadata {
26 * description of object
28 DESCRIPTION("description"),
30 * names of properties to appear in relationship-lists
31 * and parent objects in DMaaP messages
33 * <b>comma separated list</b>
35 NAME_PROPS("nameProps"),
37 * names of properties to be indexed in the
40 * <b>comma separated list</b>
42 INDEXED_PROPS("indexedProps"),
44 * name of the object this one depends on
46 DEPENDENT_ON("dependentOn"),
48 * name of the object which contains this object
50 CONTAINER("container"),
52 * the top level namespace to which this object belongs<br>
53 * <b>only valid on top level objects</b>
55 NAMESPACE("namespace"),
57 * properties which are searchable via the GUI
59 * <b>comma separated list</b>
61 SEARCHABLE("searchable"),
63 * properties marked as unique in the db schema
65 * <b>comma separated list</b>
67 UNIQUE_PROPS("uniqueProps"),
69 * properties marked as required
71 * <b>comma separated list</b>
73 REQUIRED_PROPS("requiredProps"),
75 * uri template for this object
77 URI_TEMPLATE("uriTemplate"),
79 * abstract type from which this object extends
83 * comma separated list of objects who inherit this object<br>
84 * <b>only valid on abstract objects</b>
86 INHERITORS("inheritors"),
88 * a value of true marks this object as abstract
89 * abstract objects cannot be read/written directly
90 * they resolve to "or queries" when used in queries
94 * comma separated list of properties which are alternate ways
95 * to identify this object
97 ALTERNATE_KEYS_1("alternateKeys1"),
99 * the maximum allowable retrievable depth
101 MAXIMUM_DEPTH("maximumDepth"),
103 * collection of other objects to retrieve along with this one
105 * <b>comma separated list</b>
107 CROSS_ENTITY_REFERENCE("crossEntityReference"),
109 * Marks that this object can be linked to via dataLink
111 CAN_BE_LINKED("canBeLinked"),
113 * The entity contains properties that are suggestible
115 CONTAINS_SUGGESTIBLE_PROPS("containsSuggestibleProps"),
117 * A list of aliases for the entity name (for AAI UI searches)
119 SUGGESTION_ALIASES("suggestionAliases"),
121 * a value of true allows this object to be read directly
123 ALLOW_DIRECT_READ("allowDirectRead"),
125 * a value of true allows this object to be written directly
127 ALLOW_DIRECT_WRITE("allowDirectWrite"),
129 * properties that are allowed to be in start node in a DSL
130 * <br><b>comma separated list</b>
132 DSL_START_NODE_PROPS("dslStartNodeProps");
134 private final String name;
136 private ObjectMetadata(String name) {
141 public String toString() {