WebActions.java

/*
 * (C) Copyright 2007-2016 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     Nuxeo - initial API and implementation
 */
package org.nuxeo.ecm.platform.ui.web.api;

import java.util.List;

import org.nuxeo.ecm.core.api.DocumentModel;
import org.nuxeo.ecm.platform.actions.Action;
import org.nuxeo.ecm.platform.actions.ActionContext;
import org.nuxeo.ecm.platform.actions.ejb.ActionManager;

/**
 * Component that handles actions retrieval as well as current tab(s) selection.
 *
 * @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
 */
public interface WebActions {

    String NULL_TAB_ID = "";

    /**
     * The category of actions for default tabs
     */
    String DEFAULT_TABS_CATEGORY = "VIEW_ACTION_LIST";

    /**
     * The category of actions for main tabs
     *
     * @since 5.5
     */
    String MAIN_TABS_CATEGORY = "MAIN_TABS";

    String SUBTAB_CATEGORY_SUFFIX = "_sub_tab";

    /**
     * Identifier of main tab for the "Documents management" area
     *
     * @since 5.5
     */
    String DOCUMENTS_MAIN_TAB_ID = "documents";

    /**
     * Request parameter used for tab ids settings
     *
     * @since 5.5
     */
    String TAB_IDS_PARAMETER = "tabIds";

    /**
     * Request parameter used for main tab id settings
     *
     * @since 5.5
     */
    String MAIN_TAB_ID_PARAMETER = "mainTabId";

    /**
     * Event raised when the current tab has changed, with 2 parameters: first parameter is a String representing the
     * tab category, and second parameter is a String representing the new tab id (or null if current tab is reset for
     * this category).
     *
     * @since 5.4.2
     */
    String CURRENT_TAB_CHANGED_EVENT = "currentTabChanged";

    /**
     * Event raised when the current tab is selected, with 2 parameters: first parameter is a String representing the
     * tab category, and second parameter is a String representing the new tab id (or null if current tab is reset for
     * this category).
     * <p>
     * This event is sent also when current tab did not change.
     *
     * @since 5.6
     */
    String CURRENT_TAB_SELECTED_EVENT = "currentTabSelected";

    /**
     * Framework property to control ajaxified behaviour of document tabs.
     *
     * @since 5.8
     */
    String AJAX_TAB_PROPERTY = "nuxeo.jsf.useAjaxTabs";

    /**
     * Return actions in given document context for given category.
     *
     * @param removeFiltered: if true, do not return filtered actions. Useful to display filtered actions as disabled
     *            (by using using value false).
     * @param postFilter: if true, do not filter actions. Actions will need to be filtered or disabled at render time.
     *            Useful to filter actions when filtering context is available at render time only (for instance when
     *            displaying actions in listings inside a JSF iteration done at render time).
     * @since 8.2
     */
    List<Action> getDocumentActions(DocumentModel document, String category, boolean removeFiltered,
            boolean postFilter);

    /**
     * Return action in given document context for given id.
     * <p>
     * Returns null if action is not found or filtered (depending on additional parameters).
     *
     * @param removeFiltered: if true, do not return filtered actions. Useful to display filtered actions as disabled
     *            (by using using value false).
     * @param postFilter: if true, do not filter actions. Actions will need to be filtered or disabled at render time.
     *            Useful to filter actions when filtering context is available at render time only (for instance when
     *            displaying actions in listings inside a JSF iteration done at render time).
     * @since 8.2
     */
    Action getDocumentAction(DocumentModel document, String actionId, boolean includeFiltered, boolean postFilter);

    /**
     * Return actions in given action context for given category.
     *
     * @param removeFiltered: if true, do not return filtered actions. Useful to display filtered actions as disabled
     *            (by using using value false).
     * @param postFilter: if true, do not filter actions. Actions will need to be filtered or disabled at render time.
     *            Useful to filter actions when filtering context is available at render time only (for instance when
     *            displaying actions in listings inside a JSF iteration done at render time).
     * @since 8.2
     */
    List<Action> getActions(ActionContext context, String category, boolean includeFiltered, boolean postFilter);

    /**
     * Return action in given action context for given id.
     * <p>
     * Returns null if action is not found or filtered (depending on additional parameters).
     *
     * @param removeFiltered: if true, do not return filtered actions. Useful to display filtered actions as disabled
     *            (by using using value false).
     * @param postFilter: if true, do not filter actions. Actions will need to be filtered or disabled at render time.
     *            Useful to filter actions when filtering context is available at render time only (for instance when
     *            displaying actions in listings inside a JSF iteration done at render time).
     * @since 8.2
     */
    Action getAction(ActionContext context, String actionId, boolean includeFiltered, boolean postFilter);

    /**
     * Returns true if filters evaluation for given action, in given document context, grants access.
     *
     * @since 8.2
     */
    boolean isAvailableForDocument(DocumentModel document, Action action);

    /**
     * Returns true if filters evaluation for given action, in given action context, grants access.
     *
     * @since 8.2
     */
    boolean isAvailable(ActionContext context, Action action);

    /**
     * Returns all filtered actions for a given category and given resolution context.
     * <p>
     * Actions are filtered according to filters set on the actions definitions.
     * <p>
     * Since 5.8, the category can be a list of categories, separated by commas.
     */
    List<Action> getActionsList(String category, ActionContext context);

    /**
     * Returns all filtered actions for a given category and given resolution context, creating a new context for the
     * filters resolution.
     * <p>
     * Actions are filtered according to filters set on the actions definitions.
     * <p>
     * Since 5.8, the category can be a list of categories, separated by commas.
     *
     * @since 5.7
     */
    List<Action> getActionsList(String category, Boolean removeFiltered);

    /**
     * Returns all filtered actions for a given category and a context built with given current document context,
     * creating a new context for the filters resolution.
     * <p>
     * Actions are filtered according to filters set on the actions definitions.
     * <p>
     * Since 5.8, the category can be a list of categories, separated by commas.
     *
     * @since 5.7.3
     */
    List<Action> getActionsListForDocument(String category, DocumentModel document, boolean removeFiltered);

    /**
     * Returns all filtered actions for a given category and given resolution context.
     * <p>
     * Actions are filtered according to filters set on the actions definitions.
     * <p>
     * Since 5.8, the category can be a list of categories, separated by commas.
     *
     * @since 5.7
     */
    List<Action> getActionsList(String category, ActionContext context, boolean removeFiltered);

    /**
     * Returns all filtered actions for a given category, creating a new context for the filters resolution.
     * <p>
     * Since 5.8, the category can be a list of categories, separated by commas.
     *
     * @see #getActionsList(String, ActionContext)
     */
    List<Action> getActionsList(String category);

    /**
     * Returns all actions for a given category, without filtering.
     */
    List<Action> getAllActions(String category);

    /**
     * Returns filtered actions for the category {@link #DEFAULT_TABS_CATEGORY}
     */
    List<Action> getTabsList();

    /**
     * Returns filtered actions for a category computed from the current tab action id and the suffix
     * {@link #SUBTAB_CATEGORY_SUFFIX}.
     */
    List<Action> getSubTabsList();

    /**
     * Returns the current action for category {@link #DEFAULT_TABS_CATEGORY}
     */
    Action getCurrentTabAction();

    /**
     * Sets the current action for category {@link #DEFAULT_TABS_CATEGORY}
     */
    void setCurrentTabAction(Action tabAction);

    /**
     * Returns the current sub tab for a category computed from the current tab action id and the suffix
     * {@link #SUBTAB_CATEGORY_SUFFIX}.
     */
    Action getCurrentSubTabAction();

    /**
     * Sets the current sub tab for a category computed from the current tab action id and the suffix
     * {@link #SUBTAB_CATEGORY_SUFFIX}.
     */
    void setCurrentSubTabAction(Action tabAction);

    /**
     * Returns the current action id for category {@link #DEFAULT_TABS_CATEGORY}
     */
    String getCurrentTabId();

    /**
     * Sets the current action id for category {@link #DEFAULT_TABS_CATEGORY}.
     * <p>
     * Does nothing if tabId is null, but resets current tab for this category when using an empty string instead.
     */
    void setCurrentTabId(String tabId);

    /**
     * Returns the current sub tab id for a category computed from the current tab action id and the suffix
     * {@link #SUBTAB_CATEGORY_SUFFIX}.
     */
    String getCurrentSubTabId();

    /**
     * Sets the current sub tab id for a category computed from the current tab action id and the suffix
     * {@link #SUBTAB_CATEGORY_SUFFIX}.
     * <p>
     * Does nothing if sub tab id is null, but resets current tab for this category when using an empty string instead.
     */
    void setCurrentSubTabId(String tabId);

    /**
     * Resets actions resolved for category {@link #DEFAULT_TABS_CATEGORY} so that they're recomputed. Also calls
     * {@link #resetCurrentTab()}
     */
    void resetTabList();

    /**
     * Resets current tab information (includes sub tab information) for category {@link #DEFAULT_TABS_CATEGORY}.
     */
    void resetCurrentTab();

    /**
     * Returns the current action for given category.
     */
    Action getCurrentTabAction(String category);

    /**
     * Returns the current sub tab action for given parent action, computing the category from parent action id with
     * suffix {@link #SUBTAB_CATEGORY_SUFFIX}.
     */
    Action getCurrentSubTabAction(String parentActionId);

    /**
     * Sets the current action for given category.
     * <p>
     * If given action is null, it resets the current action for this category.
     */
    void setCurrentTabAction(String category, Action tabAction);

    /**
     * Returns the current action id for given category
     */
    String getCurrentTabId(String category);

    /**
     * Indicates if the current tab id is set for given category
     *
     * @since 5.5
     */
    boolean hasCurrentTabId(String category);

    /**
     * Sets the current action for given category, with additional sub tabs.
     */
    void setCurrentTabId(String category, String tabId, String... subTabIds);

    /**
     * Returns current tab ids as a string, encoded as is: CATEGORY_1:ACTION_ID_1,CATEGORY_2:ACTION_ID_2,...
     *
     * @since 5.4.2
     */
    String getCurrentTabIds();

    /**
     * Sets current tab ids as a String, splitting on commas ',' and parsing each action information as is:
     * CATEGORY:ACTION_ID[:OPTIONAL_SUB_ACTION_ID[:OPTIONAL_SUB_ACTION_ID]...]
     * <p>
     * If category is omitted or empty, the category {@link #DEFAULT_TABS_CATEGORY} will be used (if there is no subtab
     * information).
     * <p>
     * The resulting string looks like: CATEGORY_1:ACTION_ID_1,CATEGORY_2:ACTION_ID_2_SUB_ACTION_ID_2,...
     *
     * @since 5.4.2
     */
    void setCurrentTabIds(String tabIds);

    /**
     * Resets all current tabs information.
     *
     * @since 5.4.2
     */
    void resetCurrentTabs();

    /**
     * Resets current tabs for given category, taking subtabs into account by resetting actions in categories computed
     * from reset actions id with suffix {@link #SUBTAB_CATEGORY_SUFFIX}.
     */
    void resetCurrentTabs(String category);

    /**
     * Calls {@link #setCurrentTabAndNavigate(DocumentModel, String)} for the current document.
     * <p>
     * Given action should hold the category {@link #DEFAULT_TABS_CATEGORY}
     *
     * @see NavigationContext#getCurrentDocument()
     */
    String setCurrentTabAndNavigate(String currentTabActionId);

    /**
     * Navigate to the given document and opens the view page of the given document selecting the given tab.
     * <p>
     * Given action should hold the category {@link #DEFAULT_TABS_CATEGORY}
     *
     * @param document to document which will be shown in the view page
     * @param currentTabActionId the tab that will be selected in the view page
     * @return the JSF view for the given document.
     */
    String setCurrentTabAndNavigate(DocumentModel document, String currentTabActionId);

    /**
     * @since 5.6
     * @see ActionManager#checkFilter(String, ActionContext)
     */
    boolean checkFilter(String filterId);

    /**
     * @since 5.7
     * @see ActionManager#getAction(String, ActionContext, boolean)
     */
    Action getAction(String actionId, boolean removeFiltered);

    /**
     * Return action with given id, with context filled with given document.
     *
     * @since 5.7.3
     * @see ActionManager#getAction(String, ActionContext, boolean)
     */
    Action getActionForDocument(String actionId, DocumentModel document, boolean removeFiltered);

    /**
     * @since 5.6
     * @see ActionManager#getAction(String, ActionContext, boolean)
     */
    Action getAction(String actionId, ActionContext context, boolean removeFiltered);

    /**
     * Returns true if ajaxified behaviour of tabs is activated on the server, and if history push state is supported by
     * browser.
     *
     * @since 5.8
     * @see #AJAX_TAB_PROPERTY
     * @see #canUseAjaxTabs()
     */
    boolean useAjaxTabs();

    /**
     * Returns true if history push state is supported by browser.
     *
     * @since 5.8
     * @see #useAjaxTabs()
     */
    boolean canUseAjaxTabs();

}