Content of file EMFFormsDatabinding.java

/*******************************************************************************
 * Copyright (c) 2011-2015 EclipseSource Muenchen GmbH and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 * Lucas Koehler - initial API and implementation
 ******************************************************************************/
package org.eclipse.emfforms.spi.core.services.databinding;

import org.eclipse.core.databinding.observable.list.IObservableList;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.core.databinding.property.list.IListProperty;
import org.eclipse.core.databinding.property.value.IValueProperty;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecp.view.spi.model.VDomainModelReference;

/**
 * {@link EMFFormsDatabinding} provides a databinding service. It provides four methods for getting an
 * {@link IValueProperty} or an {@link IListProperty} from a {@link VDomainModelReference} and getting an
 * {@link IObservableValue} or an {@link IObservableList} from a {@link VDomainModelReference} and an {@link EObject}.
 *
 * @author Lucas Koehler
 *
 */
public interface EMFFormsDatabinding {

	/**
	 * Returns an {@link IObservableValue} by observing the value described by the given {@link VDomainModelReference}
	 * of the given {@link EObject}.
	 *
	 * @param domainModelReference The domain model reference pointing to the desired value
	 * @param object The root object of the rendered form. If the {@link VDomainModelReference} contains a path, the
	 *            object is the first node of the path. Therefore, the {@link IObservableValue} can be bound to a
	 *            feature of a sub element in case of a path.
	 * @return The resulting {@link IObservableValue}, does not return <code>null</code>.
	 * @throws DatabindingFailedException if the databinding could not be executed successfully.
	 */
	IObservableValue getObservableValue(VDomainModelReference domainModelReference, EObject object)
		throws DatabindingFailedException;

	/**
	 * Returns an {@link IObservableList} by observing the list described by the given {@link VDomainModelReference} of
	 * the given {@link EObject}.
	 *
	 * @param domainModelReference The domain model reference pointing to the desired list
	 * @param object The root object of the rendered form. If the {@link VDomainModelReference} contains a path, the
	 *            object is the first node of the path. Therefore, the {@link IObservableValue} can be bound to a
	 *            feature of a sub element in case of a path.
	 * @return The resulting {@link IObservableList}, does not return <code>null</code>
	 * @throws DatabindingFailedException if the databinding could not be executed successfully.
	 */
	IObservableList getObservableList(VDomainModelReference domainModelReference, EObject object)
		throws DatabindingFailedException;

	/**
	 * Returns an {@link IValueProperty} described by the given {@link VDomainModelReference}.
	 *
	 * @param domainModelReference The domain model reference pointing to the desired value
	 * @param object The root object of the rendered form. If the {@link VDomainModelReference} contains a path, the
	 *            object is the first node of the path. Therefore, the {@link IValueProperty} can be bound to a feature
	 *            of a sub element in case of a path.
	 * @return The resulting {@link IValueProperty}, does not return <code>null</code>.
	 * @throws DatabindingFailedException if the databinding could not be executed successfully.
	 */
	IValueProperty getValueProperty(VDomainModelReference domainModelReference, EObject object)
		throws DatabindingFailedException;

	/**
	 * Returns an {@link IListProperty} described by the given {@link VDomainModelReference}.
	 *
	 * @param domainModelReference The domain model reference pointing to the desired list
	 * @param object The root object of the rendered form. If the {@link VDomainModelReference} contains a path, the
	 *            object is the first node of the path. Therefore, the {@link IValueProperty} can be bound to a feature
	 *            of a sub element in case of a path.
	 * @return The resulting {@link IListProperty}, does not return <code>null</code>.
	 * @throws DatabindingFailedException if the databinding could not be executed successfully.
	 */
	IListProperty getListProperty(VDomainModelReference domainModelReference, EObject object)
		throws DatabindingFailedException;
}