Interface GlobalVariableManager

    • Method Detail

      • createGlobalVariable

        GlobalVariable createGlobalVariable​(java.lang.String systemName,
                                            java.lang.String userName)
                                     throws java.lang.IllegalArgumentException
        Create a new GlobalVariable if the GlobalVariable does not exist.
        Parameters:
        systemName - the system name
        userName - the user name
        Returns:
        a new GlobalVariable or null if unable to create
        Throws:
        java.lang.IllegalArgumentException
      • createGlobalVariable

        GlobalVariable createGlobalVariable​(java.lang.String userName)
                                     throws java.lang.IllegalArgumentException
        For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.
        Parameters:
        userName - the user name
        Returns:
        a new GlobalVariable or null if unable to create
        Throws:
        java.lang.IllegalArgumentException
      • getGlobalVariable

        GlobalVariable getGlobalVariable​(java.lang.String name)
        Locate via user name, then system name if needed. Does not create a new one if nothing found
        Parameters:
        name - User name or system name to match
        Returns:
        null if no match found
      • getByUserName

        GlobalVariable getByUserName​(java.lang.String name)
        Locate an existing instance based on a user name.
        Specified by:
        getByUserName in interface Manager<GlobalVariable>
        Parameters:
        name - System Name of the required NamedBean
        Returns:
        requested NamedBean object or null if none exists
      • getAutoSystemName

        java.lang.String getAutoSystemName()
        Create a new system name for a GlobalVariable.
        Returns:
        a new system name
      • deleteGlobalVariable

        void deleteGlobalVariable​(GlobalVariable x)
        Delete GlobalVariable by removing it from the manager. The GlobalVariable must first be deactivated so it stops processing.
        Parameters:
        x - the GlobalVariable to delete
      • printTree

        void printTree​(java.util.Locale locale,
                       java.io.PrintWriter writer,
                       java.lang.String indent)
        Print the tree to a stream.
        Parameters:
        locale - The locale to be used
        writer - the stream to print the tree to
        indent - the indentation of each level