/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package de.unioninvestment.eai.portal.portlet.crud.mvp.views.configuration;

import java.util.List;

import de.unioninvestment.eai.portal.support.vaadin.mvp.View;

/**
 * Interface for a view that displays preferences in a form and writes them to
 * the portlet preferences on commit.
 * 
 * @author carsten.mjartan
 */
public interface PreferencesView extends View {

	/**
	 * Expectations that a presenter for this view has to fulfill.
	 */
	public interface Presenter {

		/**
		 * Write the changes into the portlet preferences and fire an event.
		 */
		void storePreferencesAndFireConfigChange();

	}

	/**
	 * @param preferences
	 *            the preferences to be shown in the form
	 */
	void display(List<PreferenceTO> preferences);

	/**
	 * Display an error notification.
	 * 
	 * @param message
	 *            an error message
	 */
	void showError(String message);

	/**
	 * Display an info message.
	 * 
	 * @param message
	 *            an error message
	 */
	void showNotification(String string);

	/**
	 * "Commit" the changes by updating the portlet preferences (without calling
	 * <code>store()</code>)
	 */
	void commit();

}