001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.externaldata.data;
017
018import java.util.Collection;
019
020import org.ametys.plugins.externaldata.data.Query.ResultType;
021
022/**
023 * Result of a Query. Can be either single (should have one column and one row),
024 * or multiple (one or more columns, one or more rows).
025 */
026public interface QueryResult extends Iterable<QueryResultRow>
027{
028    
029    /**
030     * Get the type of the result.
031     * @return the result type.
032     */
033    ResultType getType();
034    
035    /**
036     * Get size
037     * @return the size
038     */
039    int getSize();
040    
041    /**
042     * Get the column names.
043     * @return the column names as a Collection.
044     * @throws DataInclusionException if an error occurs while manipulating the data sources
045     */
046    Collection<String> getColumnNames() throws DataInclusionException;
047    
048    /**
049     * Close and cleanup the underlying objects and resources (resultset if SQL, LDAP resources...) if needed.
050     */
051    void close();
052}