1 /*

     2  * Copyright (c)  2017, 2018, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package jdk.incubator.sql2;

    27 

    28 import java.time.Duration;

    29 import java.util.concurrent.CompletionStage;

    30 import java.util.function.Consumer;

    31 import java.util.function.Function;

    32 

    33 /**

    34  * A {@link ParameterizedRowCountOperation} is a {@link ParameterizedOperation} that returns a count.

    35  *

    36  * @param <T> the type of the result of this {@link Operation}

    37  */

    38 public interface ParameterizedRowCountOperation<T> extends ParameterizedOperation<T>, RowCountOperation<T> {

    39   

    40   /**

    41    * Returns a {@link RowOperation} to process the auto-generated keys, if any, returned

    42    * by this {@link Operation}. If no keys are named the columns of the returned

    43    * rows are implementation dependent. If keys are specified the columns of the

    44    * returned rows are the keys. The {@link RowOperation} must be submitted before this 

    45    * {@link Operation} is submitted. If it has not submitting this {@link Operation} will

    46    * result throw {@link IllegalStateException}.

    47    * 

    48    * ISSUE: Should this be in {@link RowCountOperation}?

    49    * 

    50    * @param keys the names of the returned columns or null.

    51    * @return A RowOperation that will process the auto-generated keys

    52    * @throws IllegalStateException if this method has already been called on this

    53    * {@link Operation} or if this {@link Operation} has already been submitted.

    54    */

    55   public RowOperation<T> returning(String ... keys);

    56   

    57   // Covariant overrides

    58   

    59   @Override

    60   public ParameterizedRowCountOperation<T> onError(Consumer<Throwable> handler);

    61   

    62   @Override

    63   ParameterizedRowCountOperation<T> apply(Function<Result.RowCount, ? extends T> processor);

    64   

    65   @Override

    66   public ParameterizedRowCountOperation<T> set(String id, Object value);

    67 

    68   @Override

    69   public ParameterizedRowCountOperation<T> set(String id, Object value, SqlType type);

    70 

    71   @Override

    72   public ParameterizedRowCountOperation<T> set(String id, CompletionStage<?> source);

    73 

    74   @Override

    75   public ParameterizedRowCountOperation<T> set(String id, CompletionStage<?> source, SqlType type);

    76 

    77   @Override

    78   public ParameterizedRowCountOperation<T> timeout(Duration minTime);

    79 

    80 }