/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2010 Servoy BV

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the Free
 Software Foundation; either version 3 of the License, or (at your option) any
 later version.

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

 You should have received a copy of the GNU Affero General Public License along
 with this program; if not, see http://www.gnu.org/licenses or write to the Free
 Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
*/
package com.servoy.j2db.persistence;


import java.util.Iterator;

/**
 * Relation lookup
 * 
 * @author jblok
 */
public interface IRelationProvider
{
	/**
	 * Get all relations.
	 * 
	 * @param sort
	 * @throws RepositoryException
	 */
	public Iterator<Relation> getRelations(boolean sort) throws RepositoryException;

	/**
	 * Get relations for the table, when filterOnTable is null and isPrimaryTable is true only global relations will be returned.
	 * 
	 * @param filterOnTable
	 * @param isPrimaryTable
	 * @param sort
	 * @throws RepositoryException
	 */
	public Iterator<Relation> getRelations(ITable filterOnTable, boolean isPrimaryTable, boolean sort) throws RepositoryException;

	public Relation getRelation(String name);

	/**
	 * Get the relations from rel1.rel2.rel3
	 * 
	 * @param name
	 */
	public Relation[] getRelationSequence(String name);
}