Identifiable.java

/**
 * 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 <http://www.gnu.org/licenses/>.
 */
package org.bonitasoft.web.designer.model;

import org.joda.time.Instant;

/**
 * A component is identifiable when he has an id and a version because
 * a component can evolve between two versions of the designer.
 */
public interface Identifiable {
    /**
     * Unique id for a component
     */
    String getId();

    /**
     * A component has a name
     */
    String getName();

    /**
     * Version of the designer
     */
    String getDesignerVersion();

    /**
     * Generally a version is given when the component is created
     */
    void setDesignerVersionIfEmpty(String version);

    /**
     * The last update is audited
     */
    void setLastUpdate(Instant lastUpdate);

    boolean isFavorite();

    void setFavorite(boolean favorite);

    String getType();
}