org.bonitasoft.engine.business.application.Application 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.business.application;

import java.util.Date;

import org.bonitasoft.engine.bpm.BaseElement;
import org.bonitasoft.engine.profile.Profile;

/**
 * Contains the meta information of a Bonita Living Application.
 *
 * @author Elias Ricken de Medeiros
 * @since 6.4.0
 */
public interface Application extends BaseElement {

    /**
     * Retrieves the Application token
     *
     * @return the Application token
     */
    String getToken();

    /**
     * Retrieves the Application display name
     *
     * @return the Application display name
     */
    String getDisplayName();

    /**
     * Retrieves the Application version
     *
     * @return the Application version
     */
    String getVersion();

    /**
     * Retrieves the Application description
     *
     * @return the Application description
     */
    String getDescription();

    /**
     * Retrieves the icon path of this Application
     *
     * @return the icon path of this Application
     */
    String getIconPath();

    /**
     * Retrieves the Application creation date
     *
     * @return the Application creation date
     */
    Date getCreationDate();

    /**
     * Retrieves the identifier of the user that created this Application
     *
     * @return the identifier of the user that created this Application
     */
    long getCreatedBy();

    /**
     * Retrieves the Application last updated date
     *
     * @return the Application last updated date
     */
    Date getLastUpdateDate();

    /**
     * Retrieves the identifier of the user that updated this Application
     *
     * @return the identifier of the user that updated this Application
     */
    long getUpdatedBy();

    /**
     * Retrieves the Application state. The possible values are {@link ApplicationState#ACTIVATED#name()}
     * and {@link ApplicationState#DEACTIVATED
     * #name()}
     *
     * @return the Application state
     * @see ApplicationState
     */
    String getState();

    /**
     * Retrieves the identifier of the {@link ApplicationPage} defined as home page for this application
     *
     * @return the identifier of the {@link ApplicationPage} defined as home page for this application
     * @see ApplicationPage
     */
    Long getHomePageId();

    /**
     * Retrieves the identifier of the associated {@link Profile} or null if there is no profile is associated to this
     * application.
     *
     * @return the identifier of the associated {@link Profile} or null if there is no profile is associated to this
     *         application.
     * @see Profile
     */
    Long getProfileId();

    /**
     * Retrieves the identifier of the {@link org.bonitasoft.engine.page.Page} used as {@code Application} layout. If no
     * layout is associated to the current
     * {@code Application} the result will be {@code null}.
     *
     * @return the identifier of the {@link org.bonitasoft.engine.page.Page} used as {@code Application} layout or
     *         {@code null} if the current
     *         {@code Application} has no layout.
     * @see org.bonitasoft.engine.page.Page
     * @since 7.0.0
     */
    Long getLayoutId();

    /**
     * Retrieves the identifier of the {@link org.bonitasoft.engine.page.Page} used as {@code Application} theme. If no
     * theme is associated to the current
     * {@code Application} the result will be {@code null}.
     *
     * @return the identifier of the {@link org.bonitasoft.engine.page.Page} used as {@code Application} theme or
     *         {@code null} if the current
     *         {@code Application} has no theme.
     * @see org.bonitasoft.engine.page.Page
     * @since 7.0.0
     */
    Long getThemeId();

    /**
     * Indicate the presence or absence of an {@link Icon} for the Application that can be retrieved using
     * {@link org.bonitasoft.engine.api.ApplicationAPI#getIconOfApplication(long applicationId)}
     *
     * @see Icon
     * @return true if there is an icon for this application
     * @since 7.13.0
     */
    boolean hasIcon();

    /**
     * Retrieves the visibility of the Application. Possible values are:
     * ALL - everyone can use the application
     * TECHNICAL_USER - Only the technical user can use the application
     * RESTRICTED - Access to the application is determined by the user profile
     * These value are purely indicative, changing them in the application object won't change the accessibility to the
     * the actual application
     *
     * @return the enum ApplicationVisibility of the application
     */
    ApplicationVisibility getVisibility();

    /**
     * Indicates whether the application can be modified
     *
     * @return Whether the application can be modified
     */
    boolean isEditable();
}