/*
 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Bogdan Stefanescu
 *     Florent Guillaume
 */

package org.eclipse.ecr.core.query;

import java.util.Iterator;

import org.eclipse.ecr.core.api.DocumentModelList;

/**
 * @author Bogdan Stefanescu
 * @author Florent Guillaume
 */
public interface QueryResult {

    long count();

    /**
     * Returns the total size the query results would have if no limit and
     * offset was passed.
     *
     * @return the total size
     */
    long getTotalSize();

    boolean isEmpty();

    boolean next();

    /**
     * Retrieves the current row number. (1 based index)
     * <p>
     * If there is no current row (no next() was called) returns 0
     *
     * @return the current row number
     */
    long row();

    String getString(int i) throws QueryException;

    String getString(String column) throws QueryException;

    boolean getBoolean(int i) throws QueryException;

    boolean getBoolean(String column) throws QueryException;

    long getLong(int i, long defaultValue) throws QueryException;

    long getLong(String column, long defaultValue) throws QueryException;

    double getDouble(int i, double defaultValue) throws QueryException;

    double getDouble(String column, double defaultValue) throws QueryException;

    /**
     * Currently not implemented.
     */
    Object getObject(String column) throws QueryException;

    Object getObject() throws QueryException;

    DocumentModelList getDocumentModels() throws QueryException;

    Iterator getDocuments(int start);

}