org.bonitasoft.web.designer.model.page.Previewable Maven / Gradle / Ivy

Go to download
/** 
 * Copyright (C) 2015 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.bonitasoft.web.designer.model.page;

import java.util.List;
import java.util.Map;
import java.util.Set;

import org.bonitasoft.web.designer.model.data.Variable;
import org.bonitasoft.web.designer.model.exception.NotFoundException;

/**
 * Interface of model elements that can be previewed
 *
 * @author JB Nizet
 */
public interface Previewable {

    /**
     * Gets the rows of this previewable
     */
    List> getRows();

    /**
     * Gets the name of a previewable object
     */
    String getName();

    /**
     * Gets the variables used when previewing this previewable
     */
    Map getVariables();

    void addVariable(String name, Variable value);

    void removeVariable(String variableName) throws NotFoundException;

    Set getInactiveAssets();
}