/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2012 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.ui.runtime;

import org.mozilla.javascript.annotations.JSFunction;

/**
 * Interface for label-like components with records support
 * 
 * @author jcompagner
 * @since 6.1
 */
public interface HasRuntimeRecords
{
	/**
	 * Deletes the currently selected portal row in the foundset of the specified portal.
	 * 
	 * @sample
	 * %%prefix%%%%elementName%%.deleteRecord();
	 */
	@JSFunction
	public void deleteRecord();

	/**
	 * Creates a new portal row in the foundset of the specified portal. 
	 * 
	 * @sample
	 * // foreign key data is only filled in for equals (=) relation items 
	 * %%prefix%%%%elementName%%.newRecord();
	 */
	@JSFunction
	public void newRecord();

	/**
	 * Creates a new portal row in the foundset of the specified portal. 
	 * 
	 * @sample
	 * // foreign key data is only filled in for equals (=) relation items 
	 * //adds the new record on top
	 * %%prefix%%%%elementName%%.newRecord(true);
	 * 
	 * @param addOnTop adds the new portal record as the topmost row of the foundset, default value is true
	 */
	@JSFunction
	public void newRecord(boolean addOnTop);

	/**
	 * Duplicates the currently selected portal row in the foundset of the specified portal.
	 * 
	 * @sample
	 * // adds the duplicated record on top
	 * %%prefix%%%%elementName%%.duplicateRecord();
	 * 
	 * adds the duplicated record as the topmost record of the foundset
	 */
	@JSFunction
	public void duplicateRecord();

	/**
	 * Duplicates the currently selected portal row in the foundset of the specified portal.
	 * 
	 * @sample
	 * // adds the duplicated record on top
	 * %%prefix%%%%elementName%%.duplicateRecord(true);
	 * 
	 * @param addOnTop add on top (default true)
	 * adds the duplicated record to the foundset
	 */
	@JSFunction
	public void duplicateRecord(boolean addOnTop);

	/**
	 * Returns the sort columns names of the current portal (as comma separated string).
	 * 
	 * @sample
	 * var w = %%prefix%%%%elementName%%.getSortColumns();
	 * 
	 * @return array with column names
	 */
	@JSFunction
	public String getSortColumns();
}