QueryTextInternal.java

/**
 * OpenSpotLight - Open Source IT Governance Platform
 *
 * Copyright (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA
 * or third-party contributors as indicated by the @author tags or express
 * copyright attribution statements applied by the authors.  All third-party
 * contributions are distributed under license by CARAVELATECH CONSULTORIA E
 * TECNOLOGIA EM INFORMATICA LTDA.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU Lesser General Public License  for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 ***********************************************************************
 * OpenSpotLight - Plataforma de Governança de TI de Código Aberto
 *
 * Direitos Autorais Reservados (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA
 * EM INFORMATICA LTDA ou como contribuidores terceiros indicados pela etiqueta
 * @author ou por expressa atribuição de direito autoral declarada e atribuída pelo autor.
 * Todas as contribuições de terceiros estão distribuídas sob licença da
 * CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA.
 *
 * Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo sob os
 * termos da Licença Pública Geral Menor do GNU conforme publicada pela Free Software
 * Foundation.
 *
 * Este programa é distribuído na expectativa de que seja útil, porém, SEM NENHUMA
 * GARANTIA; nem mesmo a garantia implícita de COMERCIABILIDADE OU ADEQUAÇÃO A UMA
 * FINALIDADE ESPECÍFICA. Consulte a Licença Pública Geral Menor do GNU para mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral Menor do GNU junto com este
 * programa; se não, escreva para:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.openspotlight.graph.query;

import java.io.Serializable;
import java.util.Collection;
import java.util.Map;

import org.openspotlight.graph.exception.SLInvalidQuerySyntaxException;
import org.openspotlight.graph.manipulation.GraphReader;
import org.openspotlight.graph.query.Query.SortMode;

/**
 * The Interface SLQueryTextInternal. This class is an internal class.
 * 
 * @author porcelli
 */
public interface QueryTextInternal extends Serializable {

    /**
     * Execute.
     * 
     * @param session the session
     * @param variableValues the variable values
     * @param inputNodesIDs the input nodes i ds
     * @param sortMode the sort mode
     * @param showSLQL the show slql
     * @param limit the limit
     * @param offset the offset
     * @return the sL query result
     * @throws InvalidQueryElementException the SL invalid query element exception
     * @throws QueryException the SL query exception
     * @throws SLInvalidQuerySyntaxException the SL invalid query syntax exception
     */
    public QueryResult execute(final GraphReader session,
                                  final Map<String, ?> variableValues,
                                  final String[] inputNodesIDs,
                                  SortMode sortMode,
                                  boolean showSLQL,
                                  Integer limit,
                                  Integer offset)
        throws InvalidQueryElementException, QueryException, InvalidQuerySyntaxException;

    /**
     * Gets the unique id.
     * 
     * @return the id
     */
    public String getId();

    /**
     * Gets the output model name.
     * 
     * @return the output model name
     */
    public String getOutputModelName();

    /**
     * Gets the target.
     * 
     * @return the target
     */
    public QueryTextInternal getTarget();

    /**
     * Gets the variables.
     * 
     * @return the variables
     */
    public Collection<SLQLVariable> getVariables();

    /**
     * Checks for output model.
     * 
     * @return true, if successful
     */
    public boolean hasOutputModel();

    /**
     * Checks for target.
     * 
     * @return true, if successful
     */
    public boolean hasTarget();

    /**
     * Checks for variables.
     * 
     * @return true, if successful
     */
    public boolean hasVariables();
}