common/src/main/java/org/onap/so/client/graphinventory/entities/uri/GraphInventoryUri.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 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
  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.graphinventory.entities.uri;
  22
  23 import java.net.URI;
  24 import java.util.Map;
  25 import org.onap.so.client.graphinventory.entities.uri.Depth;
  26 import org.onap.so.client.graphinventory.GraphInventoryObjectType;
  27
  28 public interface GraphInventoryUri {
  29
  30     public URI build();
  31
  32     /**
  33      * By default GraphInventory enforces a depth of 1. Some objects can be told to retrieve objects nested beneath them
  34      * by increasing this number.
  35      *
  36      * You can use 0 to restrict the returned information to only the object you requested You can use all to retrieve
  37      * all nested objects (this should only be used if you really need a massive amount of information and are caching
  38      * the retrieval)
  39      *
  40      * @param depth
  41      * @return
  42      */
  43     public GraphInventoryUri depth(Depth depth);
  44
  45     /**
  46      * Makes client only return object fields, no relationships
  47      *
  48      * @return
  49      */
  50     public GraphInventoryUri nodesOnly(boolean nodesOnly);
  51
  52     public GraphInventoryUri queryParam(String name, String... values);
  53
  54     public GraphInventoryUri replaceQueryParam(String name, String... values);
  55
  56     public GraphInventoryUri resultIndex(int index);
  57
  58     public GraphInventoryUri resultSize(int size);
  59
  60     public GraphInventoryUri limit(int size);
  61
  62     public GraphInventoryUri clone();
  63
  64     /**
  65      * returns all key values of the URI as a map. Key names can be found in {@link GraphInventoryObjectType}
  66      *
  67      * @return
  68      */
  69     public Map<String, String> getURIKeys();
  70
  71     public GraphInventoryObjectType getObjectType();
  72
  73     public boolean equals(Object o);
  74
  75     public int hashCode();
  76 }