org.bonitasoft.engine.business.application.ApplicationSearchDescriptor 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.identity.User;
import org.bonitasoft.engine.page.Page;
import org.bonitasoft.engine.search.SearchOptions;

/**
 * Defines the fields that can be used in the {@link org.bonitasoft.engine.search.SearchOptions} when searching for
 * {@link Application}s
 *
 * @author Elias Ricken de Medeiros
 * @since 6.4
 * @see org.bonitasoft.engine.search.SearchOptions
 * @see Application
 * @see org.bonitasoft.engine.api.ApplicationAPI#searchApplications(SearchOptions)
 */
public class ApplicationSearchDescriptor {

    /**
     * Used to filter or order by the Application identifier
     */
    public static final String ID = "id";

    /**
     * Used to filter or order by the Application token
     */
    public static final String TOKEN = "token";

    /**
     * Used to filter or order by the Application display name
     */
    public static final String DISPLAY_NAME = "displayName";

    /**
     * Used to filter or order by the Application version
     */
    public static final String VERSION = "version";

    /**
     * Used to filter or order by the Application icon path
     */
    public static final String ICON_PATH = "iconPath";

    /**
     * Used to filter or order by the Application creation date
     */
    public static final String CREATION_DATE = "creationDate";

    /**
     * Used to filter or order by the identifier of the user that created the Application
     */
    public static final String CREATED_BY = "createdBy";

    /**
     * Used to filter or order by the Application last update date
     */
    public static final String LAST_UPDATE_DATE = "lastUpdateDate";

    /**
     * Used to filter or order by the identifier of the user that last updated the Application
     */
    public static final String UPDATED_BY = "updatedBy";

    /**
     * Used to filter or order by the Application state. The possible values are
     * {@link ApplicationState#ACTIVATED#name()} and
     * {@link ApplicationState#DEACTIVATED#name()}
     *
     * @see ApplicationState
     */
    public static final String STATE = "state";

    /**
     * Used to filter or order by the identifier of {@link org.bonitasoft.engine.profile.Profile} associated to the
     * {@link org.bonitasoft.engine.business.application.Application}.
     *
     * @see org.bonitasoft.engine.profile.Profile
     * @see org.bonitasoft.engine.business.application.Application
     */
    public static final String PROFILE_ID = "profileId";

    /**
     * Used to filter or order by the identifier of {@link Page} set as {@link Application} layout.
     *
     * @since 7.0.0
     * @see Page
     * @see Application
     */
    public static final String LAYOUT_ID = "layoutId";

    /**
     * Used to filter or order by the identifier of {@link Page} set as {@link Application} theme.
     *
     * @since 7.0.0
     * @see Page
     * @see Application
     */
    public static final String THEME_ID = "themeId";

    /**
     * Used to filter by the identifier of {@link User} that has access to the {@link Application}.
     *
     * @since 7.13.0
     * @see User
     * @see Application
     */
    public static final String USER_ID = "userId";
}