common/src/main/java/org/onap/so/client/aai/entities/uri/AAIUri.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   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.onap.so.client.aai.entities.uri;
  22
  23 import org.onap.so.client.aai.AAIObjectType;
  24 import org.onap.so.client.graphinventory.entities.uri.Depth;
  25 import org.onap.so.client.graphinventory.entities.uri.GraphInventoryUri;
  26
  27 public interface AAIUri extends GraphInventoryUri {
  28
  29     /**
  30      * By default A&AI enforces a depth of 1. Some objects can be told to retrieve objects nested beneath them by
  31      * increasing this number.
  32      *
  33      * You can use 0 to restrict the returned information to only the object you requested You can use all to retrieve
  34      * all nested objects (this should only be used if you really need a massive amount of information and are caching
  35      * the retrieval)
  36      *
  37      * @param depth
  38      * @return
  39      */
  40     @Override
  41     public AAIUri depth(Depth depth);
  42
  43     /**
  44      * Makes client only return object fields, no relationships
  45      *
  46      * @return
  47      */
  48     @Override
  49     public AAIUri nodesOnly(boolean nodesOnly);
  50
  51     @Override
  52     public AAIUri queryParam(String name, String... values);
  53
  54     @Override
  55     public AAIUri replaceQueryParam(String name, String... values);
  56
  57     @Override
  58     public AAIUri resultIndex(int index);
  59
  60     @Override
  61     public AAIUri resultSize(int size);
  62
  63     @Override
  64     public AAIUri limit(int size);
  65
  66     @Override
  67     public AAIUri clone();
  68
  69     @Override
  70     public AAIObjectType getObjectType();
  71 }