2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.api;
10 import com.google.common.util.concurrent.FluentFuture;
11 import org.eclipse.jdt.annotation.NonNull;
12 import org.opendaylight.mdsal.binding.api.query.QueryExpression;
13 import org.opendaylight.mdsal.binding.api.query.QueryResult;
14 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
15 import org.opendaylight.mdsal.common.api.ReadFailedException;
16 import org.opendaylight.yangtools.yang.binding.DataObject;
19 * Query-like operations supported by {@link ReadTransaction} and {@link ReadWriteTransaction}. This interface defines
20 * the operations without a tie-in with lifecycle management.
22 public interface QueryOperations {
24 * Executes a query on the provided logical data store.
26 * @param store Logical data store from which read should occur.
27 * @param query Query to execute
28 * @return a FluentFuture containing the result of the query. The Future blocks until the operation is complete.
31 * <li>The Future returns the result of the query</li>
32 * <li>If the query execution fails, the Future will fail with a {@link ReadFailedException} or
33 * an exception derived from ReadFailedException.
36 * @throws NullPointerException if any of the arguments is null
37 * @throws IllegalArgumentException if the query is not supported
39 <T extends @NonNull DataObject> @NonNull FluentFuture<QueryResult<T>> execute(@NonNull LogicalDatastoreType store,
40 @NonNull QueryExpression<T> query);