2 * ============LICENSE_START=======================================================
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
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.so.client.aai.entities.uri;
26 import org.onap.so.client.aai.AAIObjectType;
27 import org.onap.so.client.graphinventory.GraphInventoryObjectType;
28 import org.onap.so.client.graphinventory.entities.uri.Depth;
29 import org.onap.so.client.graphinventory.entities.uri.GraphInventoryUri;
31 public interface AAIUri extends GraphInventoryUri {
34 * By default A&AI enforces a depth of 1. Some objects can be told to retrieve objects
35 * nested beneath them by increasing this number.
37 * You can use 0 to restrict the returned information to only the object you requested
38 * You can use all to retrieve all nested objects (this should only be used if you really need a massive amount of information and are caching the retrieval)
43 public AAIUri depth(Depth depth);
45 * Makes client only return object fields, no relationships
50 public AAIUri nodesOnly(boolean nodesOnly);
52 public AAIUri queryParam(String name, String... values);
54 public AAIUri replaceQueryParam(String name, String... values);
56 public AAIUri clone();
59 public AAIObjectType getObjectType();