org.bonitasoft.engine.page.Page Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-common Show documentation
Bonita Common is the useful layer common to bonita-client and bonita-server
There is a newer version: 10.2.0
/**
 * Copyright (C) 2019 Bonitasoft S.A.
 * Bonitasoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library 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 Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.page;

import java.util.Date;

import org.bonitasoft.engine.bpm.BaseElement;

/**
 * A Page is a way to store, amongst other things, a binary content.
 * It is used by Bonita Portal to display specific custom content
 *
 * @author Laurent Leseigneur
 */
public interface Page extends BaseElement {

    /**
     * Get the name of this Page.
     *
     * @return the logical name of this Page.
     */
    String getName();

    /**
     * Get the display name of this Page.
     *
     * @return the display name of this Page.
     */
    String getDisplayName();

    /**
     * Is this page provided by default.
     *
     * @return true if this page is provided by default, false otherwise.
     */
    boolean isProvided();

    /**
     * Get the description of this Page.
     *
     * @return the description of this Page.
     */
    String getDescription();

    /**
     * Get the date when this page was initially installed into the Engine.
     *
     * @return the date when this page was initially installed into the Engine.
     */
    Date getInstallationDate();

    /**
     * Get the ID of the user that installed the page.
     *
     * @return the ID of the user that installed the page, or -1 if it is a default page.
     */
    long getInstalledBy();

    /**
     * Get the date when this page was last modified.
     *
     * @return the date when this page was last modified.
     */
    Date getLastModificationDate();

    /**
     * Get the userId of the user that last updated this page.
     *
     * @return the user id of the user that last updated this page.
     */
    long getLastUpdatedBy();

    /**
     * Get the name of the zip file.
     *
     * @return the name of the zip file of this Page.
     */
    String getContentName();

    /**
     * Get the type of this Page.
     *
     * @return the type of this Page. see {@link ContentType} for available values
     * @since 7.0
     */
    String getContentType();

    /**
     * Get the process definition ID of this Page.
     *
     * @return the process definition ID of this Page, or null if not set.
     * @since 7.0
     */
    Long getProcessDefinitionId();

    /**
     * Whether this page is editable
     *
     * @return Whether this page is editable
     */
    boolean isEditable();

    /**
     * Whether this page is removable
     *
     * @return Whether this page is removable
     */
    boolean isRemovable();

}