Interface ConditionalNG_Manager

    • Method Detail

      • createConditionalNG

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

        ConditionalNG createConditionalNG​(LogixNG logixNG,
                                          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:
        logixNG - The parent LogixNG
        userName - The user name
        Returns:
        a new ConditionalNG or null if unable to create
        Throws:
        java.lang.IllegalArgumentException
      • createConditionalNG

        ConditionalNG createConditionalNG​(LogixNG logixNG,
                                          java.lang.String systemName,
                                          java.lang.String userName,
                                          int threadID)
                                   throws java.lang.IllegalArgumentException
        Create a new ConditionalNG if the ConditionalNG does not exist.
        Parameters:
        logixNG - The parent LogixNG
        systemName - The system name
        userName - The user name
        threadID - The thread ID that this ConditionalNG will execute on
        Returns:
        a new ConditionalNG or null if unable to create
        Throws:
        java.lang.IllegalArgumentException
      • createConditionalNG

        ConditionalNG createConditionalNG​(LogixNG logixNG,
                                          java.lang.String userName,
                                          int threadID)
                                   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:
        logixNG - The parent LogixNG
        userName - The user name
        threadID - The thread ID that this ConditionalNG will execute on
        Returns:
        a new ConditionalNG or null if unable to create
        Throws:
        java.lang.IllegalArgumentException
      • getConditionalNG

        ConditionalNG getConditionalNG​(LogixNG logixNG,
                                       java.lang.String name)
        Locate via user name using the LogixNG, then system name if needed. Does not create a new one if nothing found
        Parameters:
        logixNG - The LogixNG for the user name match. If null, only do a system name match.
        name - User name or system name to match
        Returns:
        null if no match found
      • getParentLogixNG

        LogixNG getParentLogixNG​(java.lang.String systemName)
        Find the LogixNG which has the ConditionalNG system name in its ConditionalNG_Entry list.
        Parameters:
        systemName - The ConditionalNG system name.
        Returns:
        the parent LogixNG or null if none found.
      • getByUserName

        ConditionalNG getByUserName​(LogixNG logixNG,
                                    java.lang.String name)
        Find the ConditionalNG which is a member of the LogixNG with the supplied user name.
        Parameters:
        logixNG - The LogixNG that contains the requested ConditionalNG.
        name - The requested ConditionalNG user name.
        Returns:
        the ConditionalNG or null if none found.
      • getByUserName

        ConditionalNG getByUserName​(java.lang.String name)
        Locate an existing instance based on a user name.
        Specified by:
        getByUserName in interface Manager<ConditionalNG>
        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 ConditionalNG.
        Returns:
        a new system name
      • deleteConditionalNG

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

        void setLoadDisabled​(boolean s)
        Support for loading ConditionalNGs in a disabled state
        Parameters:
        s - true if ConditionalNG should be disabled when loaded
      • setRunOnGUIDelayed

        void setRunOnGUIDelayed​(boolean value)
        Set whenether execute() should run on the GUI thread at once or should dispatch the call until later, for all ConditionalNGs registered in this manager. Most tests turns off the delay to simplify the tests.
        Parameters:
        value - true if execute() should run on GUI thread delayed, false otherwise.