Interface NumAPIContext

  • All Known Implementing Classes:
    NumAPIContextBase

    public interface NumAPIContext
    The context state for a given module and NUM ID combination
    • Method Detail

      • getRequiredUserVariables

        UserVariable[] getRequiredUserVariables()
        Modules can have required user variables that must be supplied before the NUM record csn be retrieved.
        Returns:
        An array of objects.
      • setRequiredUserVariables

        void setRequiredUserVariables​(UserVariable[] userVariables)
                               throws NumUserVariablesException
        Update the required user variables with values obtained from the client.
        Parameters:
        userVariables - The RequiredUserVariable array with the value fields populated.
        Throws:
        NumUserVariablesException - on error