Add TopLevelMetaDataInterface

This commit is contained in:
2023-11-22 08:57:42 -06:00
parent fde84cc077
commit 1f9921b918
8 changed files with 113 additions and 8 deletions

View File

@ -30,7 +30,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
** Base-class for instance-level meta-data defined by some supplemental module, etc,
** outside of qqq core
*******************************************************************************/
public abstract class QSupplementalInstanceMetaData
public abstract class QSupplementalInstanceMetaData implements TopLevelMetaDataInterface
{
/*******************************************************************************
@ -61,4 +61,16 @@ public abstract class QSupplementalInstanceMetaData
// noop in base class //
////////////////////////
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void addSelfToInstance(QInstance qInstance)
{
qInstance.withSupplementalMetaData(this);
}
}

View File

@ -26,6 +26,8 @@ import java.util.HashMap;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonFilter;
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.TopLevelMetaDataInterface;
/*******************************************************************************
@ -33,7 +35,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
** etc) within a qqq instance
**
*******************************************************************************/
public class QAuthenticationMetaData
public class QAuthenticationMetaData implements TopLevelMetaDataInterface
{
private String name;
private QAuthenticationType type;
@ -179,4 +181,15 @@ public class QAuthenticationMetaData
return (this);
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void addSelfToInstance(QInstance qInstance)
{
qInstance.setAuthentication(this);
}
}

View File

@ -22,13 +22,15 @@
package com.kingsrook.qqq.backend.core.model.metadata.automation;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.TopLevelMetaDataInterface;
import com.kingsrook.qqq.backend.core.model.metadata.scheduleing.QScheduleMetaData;
/*******************************************************************************
** Meta-data definition of a qqq service to drive record automations.
*******************************************************************************/
public class QAutomationProviderMetaData
public class QAutomationProviderMetaData implements TopLevelMetaDataInterface
{
private String name;
private QAutomationProviderType type;
@ -137,4 +139,15 @@ public class QAutomationProviderMetaData
return (this);
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void addSelfToInstance(QInstance qInstance)
{
qInstance.addAutomationProvider(this);
}
}

View File

@ -22,11 +22,15 @@
package com.kingsrook.qqq.backend.core.model.metadata.branding;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.TopLevelMetaDataInterface;
/*******************************************************************************
** Meta-Data to define branding in a QQQ instance.
**
*******************************************************************************/
public class QBrandingMetaData
public class QBrandingMetaData implements TopLevelMetaDataInterface
{
private String companyName;
private String companyUrl;
@ -309,4 +313,14 @@ public class QBrandingMetaData
return (this);
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void addSelfToInstance(QInstance qInstance)
{
qInstance.setBranding(this);
}
}

View File

@ -25,6 +25,8 @@ package com.kingsrook.qqq.backend.core.model.metadata.dashboard;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.TopLevelMetaDataInterface;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.MetaDataWithPermissionRules;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
@ -34,7 +36,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRule
** Interface for qqq widget meta data
**
*******************************************************************************/
public interface QWidgetMetaDataInterface extends MetaDataWithPermissionRules
public interface QWidgetMetaDataInterface extends MetaDataWithPermissionRules, TopLevelMetaDataInterface
{
/*******************************************************************************
** Getter for name
@ -226,5 +228,13 @@ public interface QWidgetMetaDataInterface extends MetaDataWithPermissionRules
return (null);
}
/*******************************************************************************
**
*******************************************************************************/
default void addSelfToInstance(QInstance qInstance)
{
qInstance.addWidget(this);
}
}

View File

@ -22,10 +22,14 @@
package com.kingsrook.qqq.backend.core.model.metadata.queues;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.TopLevelMetaDataInterface;
/*******************************************************************************
** Define a provider of queues (e.g., an MQ system, or SQS)
*******************************************************************************/
public class QQueueProviderMetaData
public class QQueueProviderMetaData implements TopLevelMetaDataInterface
{
private String name;
private QueueType type;
@ -98,4 +102,15 @@ public class QQueueProviderMetaData
return (this);
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void addSelfToInstance(QInstance qInstance)
{
qInstance.addQueueProvider(this);
}
}

View File

@ -24,6 +24,8 @@ package com.kingsrook.qqq.backend.core.model.metadata.reporting;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.TopLevelMetaDataInterface;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppChildMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QIcon;
@ -35,7 +37,7 @@ import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
/*******************************************************************************
** Meta-data definition of a report generated by QQQ
*******************************************************************************/
public class QReportMetaData implements QAppChildMetaData, MetaDataWithPermissionRules
public class QReportMetaData implements QAppChildMetaData, MetaDataWithPermissionRules, TopLevelMetaDataInterface
{
private String name;
private String label;
@ -384,4 +386,15 @@ public class QReportMetaData implements QAppChildMetaData, MetaDataWithPermissio
return (this);
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void addSelfToInstance(QInstance qInstance)
{
qInstance.addReport(this);
}
}

View File

@ -22,11 +22,15 @@
package com.kingsrook.qqq.backend.core.model.metadata.security;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.TopLevelMetaDataInterface;
/*******************************************************************************
** Define a type of security key (e.g., a field associated with values), that
** can be used to control access to records and/or fields
*******************************************************************************/
public class QSecurityKeyType
public class QSecurityKeyType implements TopLevelMetaDataInterface
{
private String name;
private String allAccessKeyName;
@ -134,4 +138,15 @@ public class QSecurityKeyType
return (this);
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void addSelfToInstance(QInstance qInstance)
{
qInstance.addSecurityKeyType(this);
}
}