Package io.goobi.viewer.modules

Interface IModule

All Superinterfaces:
IndexAugmenter
public interface IModule extends IndexAugmenter

IModule interface.

  • Method Details

    • getId

      String getId()

      getId.

      Returns:
      a String object.

    • getName

      String getName()

      getName.

      Returns:
      a String object.

    • getVersion

      String getVersion()

      getVersion.

      Returns:
      a String object.

    • getVersionJson

      String getVersionJson()
      Returns:
      JSON object with version data

    • isLoaded

      boolean isLoaded()

      isLoaded.

      Returns:
      a boolean.

    • getConfiguration

      AbstractConfiguration getConfiguration()
      Module configuration object.
      Returns:
      a AbstractConfiguration object.

    • getCmsMenuContributions

      Map<String,String> getCmsMenuContributions()
      URLs for the CMS menu.
      Returns:
      a Map object.

    • getSidebarContributions

      List<String> getSidebarContributions()
      URLs to sidebar widgets.
      Returns:
      a List object.

    • getWidgetUsageContributions

      List<String> getWidgetUsageContributions()
      Contributions widget_usage.xhtml.
      Returns:
      List of HTML component URLs.

    • getAdminContributions

      List<String> getAdminContributions()
      URLs to widgets containing admin menu links.
      Returns:
      a List object.

    • getLoginNavigationContributions

      List<String> getLoginNavigationContributions()
      URLs to widgets containing navigation menu links.
      Returns:
      a List object.

    • getWidgets

      List<String> getWidgets(String type)
      Generic widget URLs than can be used from virtually anywhere. The URLs are configured in the config file.
      Parameters:
      type - a String object.
      Returns:
      a List object.

    • augmentResetRecord

      boolean augmentResetRecord()
      Any clean-up the module might want to do when resetting the currently loaded record.
      Returns:
      true if successful; false otherwise

    • deleteUserContributions

      int deleteUserContributions(User user)
      Removes content created by the given user.
      Parameters:
      user - User whose content to delete
      Returns:
      Number of deleted contributions

    • moveUserContributions

      int moveUserContributions(User fromUser, User toUser)
      Moves all content created by the given user to a different user.
      Parameters:
      fromUser - Source user
      toUser - Destination user
      Returns:
      Number of updated rows

    • getURLBuilder

      default Optional<IURLBuilder> getURLBuilder()

      getURLBuilder.

      Returns:
      the IURLBuilder for this module, if any. If this module should not alter url building, an empty optional should be returned