CTLE-436: added variant endpoint, refactored variant code a bit

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/instances/QInstanceValidator.java

@@ -1224,11 +1224,10 @@ public class QInstanceValidator
                QScheduleMetaData schedule = process.getSchedule();
                assertCondition(schedule.getRepeatMillis() != null || schedule.getRepeatSeconds() != null, "Either repeat millis or repeat seconds must be set on schedule in process " + processName);
 
-               if(schedule.getBackendVariant() != null)
+               if(schedule.getVariantBackend() != null)
                {
-                  assertCondition(schedule.getVariantRunStrategy() != null, "A variant strategy was not set for " + schedule.getBackendVariant() + " on schedule in process " + processName);
-                  assertCondition(schedule.getVariantTableName() != null, "A variant table name was not set for " + schedule.getBackendVariant() + " on schedule in process " + processName);
-                  assertCondition(schedule.getVariantFieldName() != null, "A variant field name was not set for " + schedule.getBackendVariant() + " on schedule in process " + processName);
+                  assertCondition(qInstance.getBackend(schedule.getVariantBackend()) != null, "A variant backend was not found for " + schedule.getVariantBackend());
+                  assertCondition(schedule.getVariantRunStrategy() != null, "A variant run strategy was not set for " + schedule.getVariantBackend() + " on schedule in process " + processName);
                }
             }
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/metadata/QBackendMetaData.java

@@ -43,12 +43,19 @@ public class QBackendMetaData
    private String name;
    private String backendType;
 
-   private Boolean usesVariants = false;
-   private String  variantOptionsTableName;
-
    private Set<Capability> enabledCapabilities  = new HashSet<>();
    private Set<Capability> disabledCapabilities = new HashSet<>();
 
+   private Boolean usesVariants = false;
+   private String  variantOptionsTableIdField;
+   private String  variantOptionsTableNameField;
+   private String  variantOptionsTableTypeField;
+   private String  variantOptionsTableTypeValue;
+   private String  variantOptionsTableUsernameField;
+   private String  variantOptionsTablePasswordField;
+   private String  variantOptionsTableApiKeyField;
+   private String  variantOptionsTableName;
+
    // todo - at some point, we may want to apply this to secret properties on subclasses?
    // @JsonFilter("secretsFilter")
 
@@ -381,7 +388,224 @@ public class QBackendMetaData
 
 
    /*******************************************************************************
-    ** Getter for variantsOptionTableName
+    ** Getter for variantOptionsTableIdField
+    *******************************************************************************/
+   public String getVariantOptionsTableIdField()
+   {
+      return (this.variantOptionsTableIdField);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for variantOptionsTableIdField
+    *******************************************************************************/
+   public void setVariantOptionsTableIdField(String variantOptionsTableIdField)
+   {
+      this.variantOptionsTableIdField = variantOptionsTableIdField;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for variantOptionsTableIdField
+    *******************************************************************************/
+   public QBackendMetaData withVariantOptionsTableIdField(String variantOptionsTableIdField)
+   {
+      this.variantOptionsTableIdField = variantOptionsTableIdField;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantOptionsTableNameField
+    *******************************************************************************/
+   public String getVariantOptionsTableNameField()
+   {
+      return (this.variantOptionsTableNameField);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for variantOptionsTableNameField
+    *******************************************************************************/
+   public void setVariantOptionsTableNameField(String variantOptionsTableNameField)
+   {
+      this.variantOptionsTableNameField = variantOptionsTableNameField;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for variantOptionsTableNameField
+    *******************************************************************************/
+   public QBackendMetaData withVariantOptionsTableNameField(String variantOptionsTableNameField)
+   {
+      this.variantOptionsTableNameField = variantOptionsTableNameField;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantOptionsTableTypeField
+    *******************************************************************************/
+   public String getVariantOptionsTableTypeField()
+   {
+      return (this.variantOptionsTableTypeField);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for variantOptionsTableTypeField
+    *******************************************************************************/
+   public void setVariantOptionsTableTypeField(String variantOptionsTableTypeField)
+   {
+      this.variantOptionsTableTypeField = variantOptionsTableTypeField;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for variantOptionsTableTypeField
+    *******************************************************************************/
+   public QBackendMetaData withVariantOptionsTableTypeField(String variantOptionsTableTypeField)
+   {
+      this.variantOptionsTableTypeField = variantOptionsTableTypeField;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantOptionsTableTypeValue
+    *******************************************************************************/
+   public String getVariantOptionsTableTypeValue()
+   {
+      return (this.variantOptionsTableTypeValue);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for variantOptionsTableTypeValue
+    *******************************************************************************/
+   public void setVariantOptionsTableTypeValue(String variantOptionsTableTypeValue)
+   {
+      this.variantOptionsTableTypeValue = variantOptionsTableTypeValue;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for variantOptionsTableTypeValue
+    *******************************************************************************/
+   public QBackendMetaData withVariantOptionsTableTypeValue(String variantOptionsTableTypeValue)
+   {
+      this.variantOptionsTableTypeValue = variantOptionsTableTypeValue;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantOptionsTableUsernameField
+    *******************************************************************************/
+   public String getVariantOptionsTableUsernameField()
+   {
+      return (this.variantOptionsTableUsernameField);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for variantOptionsTableUsernameField
+    *******************************************************************************/
+   public void setVariantOptionsTableUsernameField(String variantOptionsTableUsernameField)
+   {
+      this.variantOptionsTableUsernameField = variantOptionsTableUsernameField;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for variantOptionsTableUsernameField
+    *******************************************************************************/
+   public QBackendMetaData withVariantOptionsTableUsernameField(String variantOptionsTableUsernameField)
+   {
+      this.variantOptionsTableUsernameField = variantOptionsTableUsernameField;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantOptionsTablePasswordField
+    *******************************************************************************/
+   public String getVariantOptionsTablePasswordField()
+   {
+      return (this.variantOptionsTablePasswordField);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for variantOptionsTablePasswordField
+    *******************************************************************************/
+   public void setVariantOptionsTablePasswordField(String variantOptionsTablePasswordField)
+   {
+      this.variantOptionsTablePasswordField = variantOptionsTablePasswordField;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for variantOptionsTablePasswordField
+    *******************************************************************************/
+   public QBackendMetaData withVariantOptionsTablePasswordField(String variantOptionsTablePasswordField)
+   {
+      this.variantOptionsTablePasswordField = variantOptionsTablePasswordField;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantOptionsTableApiKeyField
+    *******************************************************************************/
+   public String getVariantOptionsTableApiKeyField()
+   {
+      return (this.variantOptionsTableApiKeyField);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for variantOptionsTableApiKeyField
+    *******************************************************************************/
+   public void setVariantOptionsTableApiKeyField(String variantOptionsTableApiKeyField)
+   {
+      this.variantOptionsTableApiKeyField = variantOptionsTableApiKeyField;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for variantOptionsTableApiKeyField
+    *******************************************************************************/
+   public QBackendMetaData withVariantOptionsTableApiKeyField(String variantOptionsTableApiKeyField)
+   {
+      this.variantOptionsTableApiKeyField = variantOptionsTableApiKeyField;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantOptionsTableName
     *******************************************************************************/
    public String getVariantOptionsTableName()
    {
@@ -391,7 +615,7 @@ public class QBackendMetaData
 
 
    /*******************************************************************************
-    ** Setter for variantsOptionTableName
+    ** Setter for variantOptionsTableName
     *******************************************************************************/
    public void setVariantOptionsTableName(String variantOptionsTableName)
    {
@@ -401,11 +625,11 @@ public class QBackendMetaData
 
 
    /*******************************************************************************
-    ** Fluent setter for variantsOptionTableName
+    ** Fluent setter for variantOptionsTableName
     *******************************************************************************/
-   public QBackendMetaData withVariantsOptionTableName(String variantsOptionTableName)
+   public QBackendMetaData withVariantOptionsTableName(String variantOptionsTableName)
    {
-      this.variantOptionsTableName = variantsOptionTableName;
+      this.variantOptionsTableName = variantOptionsTableName;
       return (this);
    }
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/metadata/frontend/QFrontendTableMetaData.java

@@ -72,6 +72,9 @@ public class QFrontendTableMetaData
    private boolean editPermission;
    private boolean deletePermission;
 
+   private boolean usesVariants;
+   private String  variantTableLabel;
+
    //////////////////////////////////////////////////////////////////////////////////
    // do not add setters.  take values from the source-object in the constructor!! //
    //////////////////////////////////////////////////////////////////////////////////
@@ -135,6 +138,13 @@ public class QFrontendTableMetaData
       insertPermission = PermissionsHelper.hasTablePermission(actionInput, tableMetaData.getName(), TablePermissionSubType.INSERT);
       editPermission = PermissionsHelper.hasTablePermission(actionInput, tableMetaData.getName(), TablePermissionSubType.EDIT);
       deletePermission = PermissionsHelper.hasTablePermission(actionInput, tableMetaData.getName(), TablePermissionSubType.DELETE);
+
+      QBackendMetaData backend = actionInput.getInstance().getBackend(tableMetaData.getBackendName());
+      if(backend != null && backend.getUsesVariants())
+      {
+         usesVariants = true;
+         variantTableLabel = actionInput.getInstance().getTable(backend.getVariantOptionsTableName()).getLabel();
+      }
    }
 
 
@@ -294,6 +304,17 @@ public class QFrontendTableMetaData
 
 
 
+   /*******************************************************************************
+    ** Getter for usesVariants
+    **
+    *******************************************************************************/
+   public boolean getUsesVariants()
+   {
+      return usesVariants;
+   }
+
+
+
    /*******************************************************************************
     ** Getter for exposedJoins
     **
@@ -302,4 +323,15 @@ public class QFrontendTableMetaData
    {
       return exposedJoins;
    }
+
+
+
+   /*******************************************************************************
+    ** Getter for variantTableLabel
+    *******************************************************************************/
+   public String getVariantTableLabel()
+   {
+      return (this.variantTableLabel);
+   }
+
 }

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/metadata/frontend/QFrontendVariant.java

@@ -0,0 +1,130 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2023.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.model.metadata.frontend;
+
+
+import java.io.Serializable;
+
+
+/*******************************************************************************
+ ** Version of a variant for a frontend to see
+ *******************************************************************************/
+public class QFrontendVariant
+{
+   private Serializable id;
+   private String       name;
+   private String       type;
+
+
+
+   /*******************************************************************************
+    ** Getter for id
+    *******************************************************************************/
+   public Serializable getId()
+   {
+      return (this.id);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for id
+    *******************************************************************************/
+   public void setId(Serializable id)
+   {
+      this.id = id;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for id
+    *******************************************************************************/
+   public QFrontendVariant withId(Serializable id)
+   {
+      this.id = id;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for name
+    *******************************************************************************/
+   public String getName()
+   {
+      return (this.name);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for name
+    *******************************************************************************/
+   public void setName(String name)
+   {
+      this.name = name;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for name
+    *******************************************************************************/
+   public QFrontendVariant withName(String name)
+   {
+      this.name = name;
+      return (this);
+   }
+
+
+
+   /*******************************************************************************
+    ** Getter for type
+    *******************************************************************************/
+   public String getType()
+   {
+      return (this.type);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for type
+    *******************************************************************************/
+   public void setType(String type)
+   {
+      this.type = type;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for type
+    *******************************************************************************/
+   public QFrontendVariant withType(String type)
+   {
+      this.type = type;
+      return (this);
+   }
+
+}

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/metadata/scheduleing/QScheduleMetaData.java

@@ -22,9 +22,6 @@
 package com.kingsrook.qqq.backend.core.model.metadata.scheduleing;
 
 
-import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
-
-
 /*******************************************************************************
  ** Meta-data to define scheduled actions within QQQ.
  **
@@ -46,11 +43,8 @@ public class QScheduleMetaData
    private Integer initialDelaySeconds;
    private Integer initialDelayMillis;
 
-   private RunStrategy  variantRunStrategy;
-   private String       backendVariant;
-   private String       variantTableName;
-   private QQueryFilter variantFilter;
-   private String       variantFieldName;
+   private RunStrategy variantRunStrategy;
+   private String      variantBackend;
 
 
 
@@ -191,124 +185,31 @@ public class QScheduleMetaData
 
 
    /*******************************************************************************
-    ** Getter for backendVariant
+    ** Getter for variantBackend
     *******************************************************************************/
-   public String getBackendVariant()
+   public String getVariantBackend()
    {
-      return (this.backendVariant);
+      return (this.variantBackend);
    }
 
 
 
    /*******************************************************************************
-    ** Setter for backendVariant
+    ** Setter for variantBackend
     *******************************************************************************/
-   public void setBackendVariant(String backendVariant)
+   public void setVariantBackend(String variantBackend)
    {
-      this.backendVariant = backendVariant;
+      this.variantBackend = variantBackend;
    }
 
 
 
    /*******************************************************************************
-    ** Fluent setter for backendVariant
+    ** Fluent setter for variantBackend
     *******************************************************************************/
    public QScheduleMetaData withBackendVariant(String backendVariant)
    {
-      this.backendVariant = backendVariant;
-      return (this);
-   }
-
-
-
-   /*******************************************************************************
-    ** Getter for variantTableName
-    *******************************************************************************/
-   public String getVariantTableName()
-   {
-      return (this.variantTableName);
-   }
-
-
-
-   /*******************************************************************************
-    ** Setter for variantTableName
-    *******************************************************************************/
-   public void setVariantTableName(String variantTableName)
-   {
-      this.variantTableName = variantTableName;
-   }
-
-
-
-   /*******************************************************************************
-    ** Fluent setter for variantTableName
-    *******************************************************************************/
-   public QScheduleMetaData withVariantTableName(String variantTableName)
-   {
-      this.variantTableName = variantTableName;
-      return (this);
-   }
-
-
-
-   /*******************************************************************************
-    ** Getter for variantFilter
-    *******************************************************************************/
-   public QQueryFilter getVariantFilter()
-   {
-      return (this.variantFilter);
-   }
-
-
-
-   /*******************************************************************************
-    ** Setter for variantFilter
-    *******************************************************************************/
-   public void setVariantFilter(QQueryFilter variantFilter)
-   {
-      this.variantFilter = variantFilter;
-   }
-
-
-
-   /*******************************************************************************
-    ** Fluent setter for variantFilter
-    *******************************************************************************/
-   public QScheduleMetaData withVariantFilter(QQueryFilter variantFilter)
-   {
-      this.variantFilter = variantFilter;
-      return (this);
-   }
-
-
-
-   /*******************************************************************************
-    ** Getter for variantFieldName
-    *******************************************************************************/
-   public String getVariantFieldName()
-   {
-      return (this.variantFieldName);
-   }
-
-
-
-   /*******************************************************************************
-    ** Setter for variantFieldName
-    *******************************************************************************/
-   public void setVariantFieldName(String variantFieldName)
-   {
-      this.variantFieldName = variantFieldName;
-   }
-
-
-
-   /*******************************************************************************
-    ** Fluent setter for variantFieldName
-    *******************************************************************************/
-   public QScheduleMetaData withVariantFieldName(String variantFieldName)
-   {
-      this.variantFieldName = variantFieldName;
+      this.variantBackend = backendVariant;
       return (this);
    }
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/scheduler/ScheduleManager.java

@@ -38,9 +38,13 @@ import com.kingsrook.qqq.backend.core.instances.QMetaDataVariableInterpreter;
 import com.kingsrook.qqq.backend.core.logging.LogPair;
 import com.kingsrook.qqq.backend.core.logging.QLogger;
 import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessInput;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
+import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
 import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
 import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryOutput;
 import com.kingsrook.qqq.backend.core.model.data.QRecord;
+import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
 import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
 import com.kingsrook.qqq.backend.core.model.metadata.automation.QAutomationProviderMetaData;
 import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
@@ -142,7 +146,7 @@ public class ScheduleManager
          if(process.getSchedule() != null && allowedToStart(process.getName()))
          {
             QScheduleMetaData scheduleMetaData = process.getSchedule();
-            if(process.getSchedule().getBackendVariant() == null || QScheduleMetaData.RunStrategy.SERIAL.equals(process.getSchedule().getVariantRunStrategy()))
+            if(process.getSchedule().getVariantBackend() == null || QScheduleMetaData.RunStrategy.SERIAL.equals(process.getSchedule().getVariantRunStrategy()))
             {
                ///////////////////////////////////////////////
                // if no variants, or variant is serial mode //
@@ -156,11 +160,12 @@ public class ScheduleManager
                // running at the same time, get the variant records and schedule each separately                  //
                /////////////////////////////////////////////////////////////////////////////////////////////////////
                QContext.init(qInstance, sessionSupplier.get());
+               QBackendMetaData backendMetaData = qInstance.getBackend(scheduleMetaData.getVariantBackend());
                for(QRecord qRecord : CollectionUtils.nonNullList(getBackendVariantFilteredRecords(process)))
                {
                   try
                   {
-                     startProcess(process, MapBuilder.of(scheduleMetaData.getBackendVariant(), qRecord.getValue(scheduleMetaData.getVariantFieldName())));
+                     startProcess(process, MapBuilder.of(backendMetaData.getVariantOptionsTableTypeValue(), qRecord.getValue(backendMetaData.getVariantOptionsTableIdField())));
                   }
                   catch(Exception e)
                   {
@@ -170,7 +175,7 @@ public class ScheduleManager
             }
             else
             {
-               LOG.error("Unsupported Schedule Run Strategy [" + process.getSchedule().getVariantFilter() + "] was provided.");
+               LOG.error("Unsupported Schedule Run Strategy [" + process.getSchedule().getVariantRunStrategy() + "] was provided.");
             }
          }
       }
@@ -187,10 +192,11 @@ public class ScheduleManager
       try
       {
          QScheduleMetaData scheduleMetaData = processMetaData.getSchedule();
+         QBackendMetaData  backendMetaData  = qInstance.getBackend(scheduleMetaData.getVariantBackend());
 
          QueryInput queryInput = new QueryInput();
-         queryInput.setTableName(scheduleMetaData.getVariantTableName());
-         queryInput.setFilter(scheduleMetaData.getVariantFilter());
+         queryInput.setTableName(backendMetaData.getVariantOptionsTableName());
+         queryInput.setFilter(new QQueryFilter(new QFilterCriteria(backendMetaData.getVariantOptionsTableTypeField(), QCriteriaOperator.EQUALS, backendMetaData.getVariantOptionsTableTypeValue())));
 
          QContext.init(qInstance, sessionSupplier.get());
          QueryOutput queryOutput = new QueryAction().execute(queryInput);
@@ -325,7 +331,7 @@ public class ScheduleManager
 
          try
          {
-            if(process.getSchedule().getBackendVariant() == null || QScheduleMetaData.RunStrategy.PARALLEL.equals(process.getSchedule().getVariantRunStrategy()))
+            if(process.getSchedule().getVariantBackend() == null || QScheduleMetaData.RunStrategy.PARALLEL.equals(process.getSchedule().getVariantRunStrategy()))
             {
                QContext.init(qInstance, sessionSupplier.get());
                executeSingleProcess(process, backendVariantData);
@@ -342,7 +348,8 @@ public class ScheduleManager
                   {
                      QContext.init(qInstance, sessionSupplier.get());
                      QScheduleMetaData scheduleMetaData = process.getSchedule();
-                     executeSingleProcess(process, MapBuilder.of(scheduleMetaData.getBackendVariant(), qRecord.getValue(scheduleMetaData.getVariantFieldName())));
+                     QBackendMetaData  backendMetaData  = qInstance.getBackend(scheduleMetaData.getVariantBackend());
+                     executeSingleProcess(process, MapBuilder.of(backendMetaData.getVariantOptionsTableTypeValue(), qRecord.getValue(backendMetaData.getVariantOptionsTableIdField())));
                   }
                   catch(Exception e)
                   {