Query.java

/*
   Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/

package com.mysql.clusterj;

import java.util.List;
import java.util.Map;

public interface Query<E> {

    public static final String SCAN_TYPE = "ScanType";

    static final String SCAN_TYPE_PRIMARY_KEY = "PRIMARY_KEY";

    static final String SCAN_TYPE_UNIQUE_KEY = "UNIQUE_KEY";

    static final String SCAN_TYPE_INDEX_SCAN = "INDEX_SCAN";

    static final String SCAN_TYPE_TABLE_SCAN = "TABLE_SCAN";

    static final String INDEX_USED = "IndexUsed";

    void setParameter(String parameterName, Object value);

    List<E> getResultList();

    int deletePersistentAll();

    Results<E> execute(Object parameter);

    Results<E> execute(Object... parameters);

    Results<E> execute(Map<String, ?> parameters);

    Map<String, Object> explain();

}