/**Copyright 2010 Research Studios Austria Forschungsgesellschaft mBH
 *
 * This file is part of easyrec.
 *
 * easyrec 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * easyrec 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 easyrec.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.easyrec.store.dao.core.types;

import org.easyrec.utils.spring.store.dao.TableCreatingDAO;

import java.util.HashMap;
import java.util.Set;

/**
 * This interface provides methods to manage <code>ItemType</code> entries within an easyrec database.
 * <p/>
 * <p><b>Company: </b>
 * SAT, Research Studios Austria</p>
 * <p/>
 * <p><b>Copyright: </b>
 * (c) 2007</p>
 * <p/>
 * <p><b>last modified:</b><br/>
 * $Author: dmann $<br/>
 * $Date: 2011-10-07 17:52:32 +0200 (Fr, 07 Okt 2011) $<br/>
 * $Revision: 18617 $</p>
 *
 * @author Roman Cerny
 */
public interface ItemTypeDAO extends TableCreatingDAO {
    // constants
    public final static String DEFAULT_TABLE_NAME = "itemtype";

    public final static String DEFAULT_TENANT_COLUMN_NAME = "tenantId";
    public final static String DEFAULT_NAME_COLUMN_NAME = "name";
    public final static String DEFAULT_ID_COLUMN_NAME = "id";
    public final static String DEFAULT_VISIBLE_COLUMN_NAME = "visible";

    // methods
    public int insertOrUpdate(Integer tenantId, String itemType);

    public int insertOrUpdate(Integer tenantId, String itemType, Boolean visible);

    public int insertOrUpdate(Integer tenantId, String itemType, Integer id);

    public int insertOrUpdate(Integer tenantId, String itemType, Integer id, Boolean visible);

    public String getTypeById(Integer tenantId, final Integer id);

    public Integer getIdOfType(Integer tenantId, final String itemType);

    public Integer getIdOfType(Integer tenantId, final String itemType, Boolean visible);

    public boolean isVisible(Integer tenantId, final Integer id);

    public boolean isVisible(Integer tenantId, final String itemType);

    public HashMap<String, Integer> getMapping(Integer tenantId);

    public HashMap<String, Integer> getMapping(Integer tenantId, Boolean visible);

    public Set<String> getTypes(Integer tenantId);

    /**
     * This function return itemTypes of a given tenant. You can either load
     * all invisible or all visible itemTypes.
     *
     * @param tenantId the tenantId you want to get the iTemTypes From
     * @param visible  set it to true to load all visible items or to false to load all invisible items.
     * @return a list of itemType names.
     */
    public Set<String> getTypes(Integer tenantId, Boolean visible);


}