/*
 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.dataprocessing;


/**
 * Value entry interface
 * @author jblok
 * @since Servoy 5.0
 */
public interface IGlobalValueEntry
{
	/**
	 * Check if contains the specified global or aggregate dataprovider
	 * 
	 * @param dataProviderID the dataprovider to check
	 */
	public boolean containsDataProvider(String dataProviderID);

	/**
	 * Get the value from the specified global or aggregate dataprovider, always check first width {@link #containsDataProvider(String)}
	 * 
	 * @param dataProviderID the dataprovider
	 * @return the value
	 */
	public Object getDataProviderValue(String dataProviderID);

	/**
	 * Used for globals
	 * 
	 * @param dataProviderID to set
	 * @param value new value
	 * @return the old value when change, otherwise null
	 */
	public Object setDataProviderValue(String dataProviderID, Object value);
}