org.eclipse.osbp.runtime.web.ecview.services.vaadin/src/org/eclipse/osbp/runtime/web/ecview/services/vaadin/IECViewUIRenderService.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 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:
 *         Florian Pirchner - Initial implementation
 */

package org.eclipse.osbp.runtime.web.ecview.services.vaadin;

import java.util.Map;

import org.eclipse.osbp.ecview.core.common.context.IViewContext;

import com.vaadin.ui.ComponentContainer;

// TODO: Auto-generated Javadoc
/**
 * Is used to render a UI for a given dto or entity.
 */
public interface IECViewUIRenderService {

	/**
	 * Renders an UI for the given dto class.
	 *
	 * @param clazz
	 *            - the dto class
	 * @param component
	 *            - the component container. Must be attached to an UI instance.
	 * @param beanSlots
	 *            - The map entry is registered as a bean slot
	 * @param renderingOptions
	 *            - The rendering options
	 * @return the i view context
	 */
	IViewContext renderUIForDTO(Class<?> clazz, ComponentContainer component,
			Map<String, Object> beanSlots, Map<String, Object> renderingOptions);

	/**
	 * Renders an UI for the given dto instance and also create the required
	 * bindings.
	 *
	 * @param dto
	 *            - the dto instance
	 * @param component
	 *            - the component container. Must be attached to an UI instance.
	 * @param beanSlots
	 *            - The map entry is registered as a bean slot
	 * @param renderingOptions
	 *            - The rendering options
	 * @return the i view context
	 */
	IViewContext renderUIForDTO(Object dto, ComponentContainer component,
			Map<String, Object> beanSlots, Map<String, Object> renderingOptions);

	/**
	 * Renders an UI for the given entity class.
	 *
	 * @param clazz
	 *            - the dto class
	 * @param component
	 *            - the component container. Must be attached to an UI instance.
	 * @param beanSlots
	 *            - The map entry is registered as a bean slot
	 * @param renderingOptions
	 *            - The rendering options
	 * @return the i view context
	 */
	IViewContext renderUIForEntity(Class<?> clazz,
			ComponentContainer component, Map<String, Object> beanSlots,
			Map<String, Object> renderingOptions);

	/**
	 * Renders an UI for the given entity instance and also create the required
	 * bindings.
	 *
	 * @param entity
	 *            - the entity instance
	 * @param component
	 *            - the component container. Must be attached to an UI instance.
	 * @param beanSlots
	 *            - The map entry is registered as a bean slot
	 * @param renderingOptions
	 *            - The rendering options
	 * @return the i view context
	 */
	IViewContext renderUIForEntity(Object entity, ComponentContainer component,
			Map<String, Object> beanSlots, Map<String, Object> renderingOptions);

}