org.bonitasoft.engine.api.APIAccessor 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.api;

import java.io.Serializable;

/**
 * Gives access to some common APIs.
 *
 * @author Matthieu Chaffotte
 * @author Celine Souchet
 * @author Emmanuel Duchastenier
 */
public interface APIAccessor extends Serializable {

    /**
     * Gives access to the IdentityAPI
     *
     * @return an IdentityAPI
     */
    IdentityAPI getIdentityAPI();

    /**
     * Gives access to the ProcessAPI
     *
     * @return an ProcessAPI
     */
    ProcessAPI getProcessAPI();

    /**
     * Gives access to the CommandAPI
     *
     * @return an CommandAPI
     */
    CommandAPI getCommandAPI();

    /**
     * Gives access to the ProfileAPI
     *
     * @return an ProfileAPI
     */
    ProfileAPI getProfileAPI();

    /**
     * Gives access to the ThemeAPI
     *
     * @return an ThemeAPI
     * @deprecated since 7.13.0, ThemeAPI does nothing. There is no replacement, as it used to serve old removed
     *             feature.
     */
    @Deprecated(since = "7.13.0")
    ThemeAPI getThemeAPI();

    /**
     * Gives access to the PermissionAPI
     *
     * @return an PermissionAPI
     */
    PermissionAPI getPermissionAPI();

    /**
     * Gives access to the PageAPI
     *
     * @return an PageAPI
     */
    PageAPI getCustomPageAPI();

    /**
     * Gives access to the ApplicationAPI
     *
     * @return an ApplicationAPI
     */
    ApplicationAPI getLivingApplicationAPI();

    /**
     * Gives access to the BusinessDataAPI
     *
     * @return an BusinessDataAPI
     * @deprecated as of 7.3, see {@link BusinessDataAPI} for replacements
     */
    @Deprecated
    BusinessDataAPI getBusinessDataAPI();

}