/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 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.aaiclient.client.graphinventory.entities.uri;

import java.io.Serializable;
import java.net.URI;
import java.util.Map;
import java.util.regex.Pattern;
import org.onap.aaiclient.client.graphinventory.GraphInventoryObjectBase;
import org.onap.aaiclient.client.graphinventory.GraphInventoryObjectType;

public interface GraphInventoryUri<T extends GraphInventoryUri<?, ?>, OT extends GraphInventoryObjectBase>
        extends Serializable {

    public URI build();

    /**
     * By default GraphInventory enforces a depth of 1. Some objects can be told to retrieve objects nested beneath them
     * by increasing this number.
     * 
     * You can use 0 to restrict the returned information to only the object you requested 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)
     * 
     * @param depth
     * @return
     */
    public T depth(Depth depth);

    /**
     * Makes client only return object fields, no relationships
     * 
     * @return
     */
    public T nodesOnly(boolean nodesOnly);

    public T queryParam(String name, String... values);

    public T replaceQueryParam(String name, String... values);

    public T resultIndex(int index);

    public T resultSize(int size);

    public T limit(int size);

    public T clone();

    /**
     * returns all key values of the URI as a map. Key names can be found in {@link GraphInventoryObjectType}
     * 
     * @return
     */
    public Map<String, String> getURIKeys();

    public OT getObjectType();

    public boolean equals(Object o);

    public int hashCode();

    public Pattern getPrefixPattern();
}