Package de.xima.fc.plugin.config

Interface IProcessingBean

  • All Known Implementing Classes:
    APluginCustomGUIBean, ProcessingBean
    public interface IProcessingBean
    Interface for accessing data related to the workflow processing, meant for custom workflow UIs provided by a processing plugin. Also gives access to the current project, the current state and the current entity context for performing database operations.
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • setFilterForParameter

        @Deprecated
default void setFilterForParameter​(Set<String> filterParams)
        Deprecated.
        If you want to include a list of parameters in the UI and filter out some attributes, implement the filter yourself.
        This method is a no-op that ignore the given argument.

      • getFilteredParameters

        @Deprecated
default List<IParameterModel> getFilteredParameters()
        Deprecated.
        If you want to include a list of parameters in the UI and filter out some attributes, implement the filter yourself.
        This method is a stub that always returns the full parameter list.

      • isNewWorkflow

        default boolean isNewWorkflow()

      • getAllParameter

        List<IParameterModel> getAllParameter()
        Returns the list of all parameters.
        Returns:
        A List with a processing parameters.

      • getParameter

        IParameterModel getParameter​(String paramName)
        Finds the parameter with the given name in the list of parameters
        Parameters:
        paramName - Name of the parameter to get
        Returns:
        The IParameterModel for the parameter, or null when no such parameter exists

      • addNewParameter

        IParameterModel addNewParameter​(String paramName)
        Adds a new parameter to the list of parameters, and returns the newly created IParameterModel for that parameter.
        Parameters:
        paramName - Name of the parameter to add
        Returns:
        The newly created IParameterModel

      • removeParameter

        void removeParameter​(String paramName)
        Removes the parameter with the given name from the list of parameters.
        Parameters:
        paramName - Name of the parameter to remove

      • removeParameter

        void removeParameter​(int idx)
        Removes the parameter at the given index from the list of parameters.
        Parameters:
        idx - 0-based index of the parameter to remove.

      • getProvidingPrevActions

        List<Aktion> getProvidingPrevActions()
        Liefert eine Liste mit allen datei-bereitstellenden Aktionen, welche der aktuellen Aktion innerhalb des aktuellen Status vorgelagert sind
        Returns:
        an list of actions which provides files

      • getCurrentProject

        Projekt getCurrentProject()
        Finds the project to which the workflow action belong
        Returns:
        The current Projekt

      • getCurrentState

        Status getCurrentState()
        Finds the state to which the workflow action belongs
        Returns:
        The current Status of the action

      • getEntityContext

        IEntityContext getEntityContext()
        Finds the entity context that can be used to access the database.
        Returns:
        A IEntityContext for the database

      • getCurrentAction

        Aktion getCurrentAction()
        Finds the currently selected workflow action.
        Returns:
        The selected workflow action.

      • getCurrentLocale

        Locale getCurrentLocale()
        Finds the locale the current user is using.
        Returns:
        The current locale