Class QInstanceHelpContentManager

java.lang.Object
com.kingsrook.qqq.backend.core.instances.QInstanceHelpContentManager
public class QInstanceHelpContentManager extends Object
Utility methods for working with (dynamic, from a table) HelpContent - and putting it into meta-data in a QInstance.

  • Constructor Details

    • QInstanceHelpContentManager

      public QInstanceHelpContentManager()

  • Method Details

    • loadHelpContent

      public static void loadHelpContent(QInstance qInstance)

    • processHelpContentRecord

      public static void processHelpContentRecord(QInstance qInstance, QRecord record)

    • putHelpContentInList

      public static void putHelpContentInList(QHelpContent helpContent, List<QHelpContent> helpContents)
      add a help content object to a list - replacing an entry in the list with the same roles if one is found.

    • removeHelpContentByRoleSetFromList

      public static void removeHelpContentByRoleSetFromList(Set<HelpRole> roles, List<QHelpContent> helpContents)
      Remove any helpContent entries in a list if they have a set of roles that matches the input set.

    • setReloadIntervalMillis

      public static void setReloadIntervalMillis(long intervalMillis)
      Configure the per-instance poll throttle; zero is useful for deterministic tests.

    • reloadIfChanged

      public static void reloadIfChanged(QInstance instance)
      Reload only after the table's count/max-modifyDate signature changes. Polling is internal metadata maintenance, independent of the viewing user's permissions on the authoring table. The user's context is always restored.

    • reloadHelpContent

      public static void reloadHelpContent(QInstance instance)
      Replace data-applied help, restoring any code declaration it had overridden.

    • cloneHelpContent

      public static Map<String,List<QHelpContent>> cloneHelpContent(Map<String,List<QHelpContent>> contents)
      Deep copy help slots when metadata is cloned.