Package de.espirit.firstspirit.ui.gadgets.aspects.operations

Interface SelectStoreElementOperation

public interface SelectStoreElementOperation
Highly configurable operation providing means to select one or more store elements.
Since:
5.0.101

  • Field Details

  • Method Details

    • setTitle

      void setTitle(String title)
      Sets the selection view's title.
      Parameters:
      title - The view title.
      Since:
      5.0.101

    • setPreselection

      void setPreselection(@Nullable @Nullable String projectName, @NotNull @NotNull IDProvider element, @Nullable @Nullable Resolution resolution)
      Sets a preselection.
      Parameters:
      projectName - The symbolic name of the project the element belongs to or null, if it is not remote.
      element - The element to be pre-selected.
      resolution - The resolution of a picture, if the element refers to a picture.
      Since:
      5.0.101

    • setMultiSelect

      void setMultiSelect(boolean enable)
      Enables multiple selection. If not set, defaults to false.
      Parameters:
      enable - If true, enables multi selection.
      Since:
      5.0.101

    • setSelectResolution

      void setSelectResolution(boolean enable)
      Enables resolution selection on picture elements. If not set, defaults to false.
      Parameters:
      enable - If true, enables resolution selection.
      Since:
      5.0.101

    • addTypeToSelect

      void addTypeToSelect(Class<?> type)
      Adds a type where elements thereof are eligible for selection.
      Parameters:
      type - Type of selectable elements.
      Since:
      5.0.101

    • addTypeToHide

      void addTypeToHide(Class<?> type)
      Adds a type to be hidden on displaying selectable and navigatable elements.

      Note: Elements allowed for selection will not be hidden.

      Parameters:
      type - Type to be hidden.
      Since:
      5.0.101

    • addProject

      @NotNull @NotNull ProjectOptions addProject(@Nullable @Nullable String remoteProjectName)
      Adds the named project as selection source. If the name is null, the local project is added.
      Parameters:
      remoteProjectName - The symbolic name of the remote project or null.
      Returns:
      An option handler to further restrict the added project.
      Since:
      5.0.101

    • addProjectFromRestriction

      void addProjectFromRestriction(@NotNull @NotNull ProjectRestriction projectRestriction)
      Add a project from a clause representation.
      Parameters:
      projectRestriction - The clause to derive from.
      Since:
      5.0.101

    • applyFilterFolderBased

      void applyFilterFolderBased(boolean folderBased)
      The element selection filter allows/shows only child elements of folders.
      Parameters:
      folderBased - true if folder based otherwise false
      Since:
      5.0.101

    • applyFilterUidBased

      void applyFilterUidBased(boolean uidBased)
      The element selection filter allows/shows only child elements having a UID.
      Parameters:
      uidBased - true if uid based otherwise false
      Since:
      5.1.404

    • setAllowLeafsOnly

      void setAllowLeafsOnly(boolean leafsOnly)
      Restricts the final selection to leaf elements, i.e. elements not having any children, real or virtual.
      Parameters:
      leafsOnly - true, to allow leafs elements only.
      Since:
      5.0.101

    • selectUiType

      void selectUiType(@NotNull @NotNull SelectUiType uiType)
      Set the type of user interface which is used to make a selection. Defaults to SelectUiType.DIALOG.
      Parameters:
      uiType - the type used for selection
      Since:
      5.0.101

    • setSelectFromRelease

      void setSelectFromRelease(boolean release)
      Defines, whether released elements will be provided for selection. Default is false, allowing selections of current (unreleased) elements.
      Parameters:
      release - if true, provides released elements for selection, if false, provides current elements.
      Since:
      5.0.101

    • setLanguage

      void setLanguage(Language language)
      Defines the contextual data language for this operation, which might be relevant to the elements offered.
      Parameters:
      language - The contextual language.
      Since:
      5.2.425

    • perform

      @NotNull @NotNull List<SelectStoreElementOperation.Selection> perform()
      Performs the operation with the previously set configuration and returns the set of selections.
      Returns:
      The result of the selection operation.
      Since:
      5.0.101