/*
 * Copyright (c) 2005-2011 Grameen Foundation USA
 * All rights reserved.
 *
 * Licensed 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
 *
 *     http://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.
 *
 * See also http://www.apache.org/licenses/LICENSE-2.0.html for an
 * explanation of the license and how it is applied.
 */

package org.mifos.framework.hibernate.helper;

import java.util.ArrayList;
import java.util.List;

import org.hibernate.type.Type;

/**
 * This is the interface that is returned on a search operation. Search would
 * typically result in a set of search result objects , these search result
 * objects would be obtained through hibernate scroll for pagination in the
 * front end , the associate hibernate session would be held in this object , a
 * call to close from the front end on this interface would result in the
 * hibernate session object getting closed.
 */
@SuppressWarnings("PMD")
@edu.umd.cs.findbugs.annotations.SuppressWarnings(value={"EI_EXPOSE_REP", "EI_EXPOSE_REP2"}, justification="should disable at filter level and also for pmd - not important for us")
public class QueryInputs {

    private String dtoPath;

    private Type[] returnTypes;

    private String[] aliasNames;

    private boolean buildDTO = true;	

    private String[] queryStrings = new String[2];

    List paramList = new ArrayList();

    public List getParamList() {
        return paramList;
    }

    public void setParamList(List paramList) {
        this.paramList = paramList;
    }

    public String[] getQueryStrings() {
        return queryStrings;
    }

    public void setQueryStrings(String[] queryStrings) {
        this.queryStrings = queryStrings;
    }

    /**
     * Set the path which will be used for building the DTO
     */
    public void setPath(String path) {
        this.dtoPath = path;
    }

    /**
     * Set the return types which will be used for building the DTO
     */
    public void setTypes(Type[] returnTypes) {
        this.returnTypes = returnTypes;
    }

    /**
     * Set the alias names of the columns which will be used for building the
     * DTO
     */
    public void setAliasNames(String[] aliasNames) {
        this.aliasNames = aliasNames;
    }

    /**
     * Return the path for building the DTO
     */
    public String getPath() {
        return dtoPath;
    }

    /**
     * Return the types for building the DTO
     */

    public Type[] getTypes() {
        return returnTypes;
    }

    /**
     * Return the alias names for building the DTO
     */
    public String[] getAliasNames() {
        return aliasNames;
    }

    /**
     * Return the boolean to indicate wether DTO has to be built
     */
    public boolean getBuildDTO() {
        return buildDTO;
    }

}