Package com.blueriq.component.api.shortcut

Interface IShortcutManager

public interface IShortcutManager
Manager that reads the configured shortcuts and can create ProjectRequests from it.

Shortcuts can be used to run Aquima projects from a simple url.

Since:
8.0
Author:
Danny Roest

  • Method Details

    • getProjectRequest

      IProjectReference getProjectRequest(String shortcut)
      This method returns the project request for the specified shortcut.
      Parameters:
      shortcut - the name of the shortcut (case sensitive)
      Returns:
      the project request for the shortcut or null if the shortcut is unkown.

    • getProjectRequest

      IProjectReference getProjectRequest(String shortcut, boolean includePrivate)
      This method returns the project request for the specified shortcut.
      Parameters:
      shortcut - the name of the shortcut (case sensitive)
      includePrivate - boolean value indicating whether private shortcuts should be included
      Returns:
      the project request for the shortcut or null if the shortcut is unkown.

    • getDefaultProjectRequest

      IProjectReference getDefaultProjectRequest()
      This method returns the default project request for the default shortcut. If there is no shortcut configured with the default name and there is only one shortcut defined, this method returns that the project request related to that shortcut.
      Returns:
      the default project request or null if there is not default project request

    • getShortcutNames

      List<String> getShortcutNames()

    • getShortcuts

      List<IShortcut> getShortcuts()

    • getShortcut

      IShortcut getShortcut(String name)

    • getDefaultShortcut

      IShortcut getDefaultShortcut()