org.bonitasoft.engine.business.application.ApplicationField 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 org.bonitasoft.engine.profile.Profile;

/**
 * Contains fields that can be used by {@link ApplicationCreator} and {@link ApplicationUpdater}
 *
 * @author Elias Ricken de Medeiros
 * @see ApplicationCreator
 * @see ApplicationUpdater
 * @since 7.0.0
 */
public enum ApplicationField {

    /**
     * References the {@link Application} token
     *
     * @see Application
     */
    TOKEN,

    /**
     * References the {@link Application} display name
     *
     * @see Application
     */
    DISPLAY_NAME,

    /**
     * References the {@link Application} version
     *
     * @see Application
     */
    VERSION,

    /**
     * References the {@link Application} description
     *
     * @see Application
     */
    DESCRIPTION,

    /**
     * References the {@link Application} icon path
     *
     * @see Application
     * @deprecated since 7.13.0, use {@link #ICON_CONTENT} and {@link #ICON_FILE_NAME} instead
     */
    @Deprecated(since = "7.13.0")
    ICON_PATH,

    /**
     * byte array content of the icon of the {@link Application}
     *
     * @since 7.13.0
     */
    ICON_CONTENT,

    /**
     * Filename of the icon of the {@link Application}
     *
     * @since 7.13.0
     */
    ICON_FILE_NAME,

    /**
     * References the {@link Application} state
     *
     * @see Application
     */
    STATE,

    /**
     * References the identifier of the {@link Profile} associated to the {@link Application}
     *
     * @see Application
     * @see Profile
     */
    PROFILE_ID,

    /**
     * References the identifier of the {@link ApplicationPage} defined as the {@link Application} home page
     *
     * @see org.bonitasoft.engine.business.application.ApplicationPage
     * @see org.bonitasoft.engine.business.application.Application
     */
    HOME_PAGE_ID,

    /**
     * References the identifier of the {@link org.bonitasoft.engine.page.Page} defined as the {@link Application}
     * layout.
     *
     * @see org.bonitasoft.engine.page.Page
     * @see org.bonitasoft.engine.business.application.Application
     * @since 7.0.0
     */
    LAYOUT_ID,

    /**
     * References the identifier of the {@link org.bonitasoft.engine.page.Page} defined as the {@link Application}
     * theme.
     *
     * @see org.bonitasoft.engine.page.Page
     * @see org.bonitasoft.engine.business.application.Application
     * @since 7.0.0
     */
    THEME_ID

}