cayenne/src/main/java/org/apache/cayenne/QueryResultItem.java

/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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
 *
 *    https://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.
 ****************************************************************/
package org.apache.cayenne;

import java.util.List;

/**
 * Represents a single item in a multipart query execution. Can be either an
 * update count or a list of objects.
 *
 * @since 4.0
 */
public interface QueryResultItem<T> {

    /**
     * Returns true if encapsulated result is a select result.
     */
    boolean isSelectResult();

    /**
     * Returns true if encapsulated result is a batch update result.
     */
    boolean isBatchUpdate();

    /**
     * Returns a list of selected objects. Throws unless
     * {@link #isSelectResult()} returns true.
     */
    List<T> getSelectResult();

    /**
     * Returns an update count.
     */
    int getUpdateCount();

    /**
     * Returns batch update result in a form of array of individual update counts.
     */
    int[] getBatchUpdateCounts();

}