org.eclipse.osbp.ecview.core.common/src/org/eclipse/osbp/ecview/core/common/binding/observables/IContextBindingDelegate.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *         Florian Pirchner - Initial implementation
 */
package org.eclipse.osbp.ecview.core.common.binding.observables;

import java.net.URI;

import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.list.IObservableList;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.osbp.ecview.core.common.beans.IBeanRegistry;
import org.eclipse.osbp.ecview.core.common.beans.ISlot;

// TODO: Auto-generated Javadoc
/**
 * Binding delegates are used to offer a common interface for databinding.
 * Subclasses should implement the databinding for the respective type. For
 * instance <code>pojo binding</code>, <code>bean binding</code> and
 * <code>emf binding</code>.
 * <p>
 * The {@link #isFor(IBeanRegistry, URI)} is used to check if the delegate can be used for
 * the given object.
 * 
 * @noimplement - Do not directly implement the interface. Implement
 *              ContextBindingDelegate since methods declarations may be added.
 */
public interface IContextBindingDelegate {

	/**
	 * Returns true if that binding delegate can be used for the URI.
	 *
	 * @param registry
	 *            the registry
	 * @param bindingURI
	 *            the binding uri
	 * @return true, if is for
	 */
	boolean isFor(IBeanRegistry registry, URI bindingURI);

	/**
	 * Returns an observable value tracking the value of the context described
	 * by the binding URI.
	 * 
	 * @param registry
	 *            the registry.
	 * @param bindingURI
	 *            the URI that keeps the binding target information.
	 * @return an observable value tracking the value of the context described
	 *         by the binding URI
	 * @throws IllegalArgumentException if the {@link ISlot} bean slot was not
	 *        created yet.
	 */
	IObservableValue observeValue(IBeanRegistry registry, URI bindingURI);

	/**
	 * Returns an observable value tracking the value of the context described
	 * by the binding URI.
	 * 
	 * @param realm
	 *            the realm
	 * @param registry
	 *            the registry.
	 * @param bindingURI
	 *            the URI that keeps the binding target information.
	 * @return an observable value tracking the value of the context described
	 *         by the binding URI
	 * @throws IllegalArgumentException if the {@link ISlot} bean slot was not
	 *        created yet.
	 */
	IObservableValue observeValue(Realm realm, IBeanRegistry registry,
			URI bindingURI);

	/**
	 * Returns an observable list tracking the nested value of the context
	 * described by the binding URI.
	 * 
	 * @param registry
	 *            the registry.
	 * @param bindingURI
	 *            the URI that keeps the binding target information.
	 * @param elementType
	 *            the element type contained in the list.
	 * @return an observable list tracking the nested value of the context
	 *         described by the binding URI
	 * @throws IllegalArgumentException if the {@link ISlot} bean slot was not
	 *        created yet.
	 */
	IObservableList observeList(IBeanRegistry registry, URI bindingURI,
			Class<?> elementType);

	/**
	 * Returns an observable list tracking the nested value of the context
	 * described by the binding URI.
	 * 
	 * @param realm
	 *            the realm
	 * @param registry
	 *            the registry.
	 * @param bindingURI
	 *            the URI that keeps the binding target information.
	 * @param elementType
	 *            the element type contained in the list.
	 * @return an observable list tracking the nested value of the context
	 *         described by the binding URI
	 * @throws IllegalArgumentException if the {@link ISlot} bean slot was not
	 *        created yet.
	 */
	IObservableList observeList(Realm realm, IBeanRegistry registry,
			URI bindingURI, Class<?> elementType);

}