Class EsbTableMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.tables.QSupplementalTableMetaData

com.kingsrook.qqq.esb.model.EsbTableMetaData

All Implemented Interfaces:

Cloneable

public class EsbTableMetaData
extends QSupplementalTableMetaData

Table-level ESB meta-data: the destinations a table publishes its record change events to. Not included in frontend meta-data; the UI reads it through the permission-checked ESB endpoints.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
EsbTableMetaData()

Method Summary

Modifier and Type	Method	Description
protected EsbTableMetaData	finishClone(QSupplementalTableMetaData abstractClone)	finish the cloning operation started in the base class. copy all state from the subclass into the input clone (which can be safely casted to the subclass's type, as it was obtained by super.clone()) Rather than making this public and breaking all existing implementations that don't have it - we're making it protected, with a one-time warning if it isn't implemented in a subclass.
List<EsbTablePublication>	getPublications()	Getter for publications
String	getType()	Getter for type
boolean	includeInFullFrontendMetaData()
boolean	includeInPartialFrontendMetaData()
static EsbTableMetaData	of(QTableMetaData table)	Get the ESB meta-data on a table - or null if it has none.
static EsbTableMetaData	ofOrWithNew(QTableMetaData table)	Get the ESB meta-data on a table - creating (and adding) it if the table doesn't have any yet.
void	setPublications(List<EsbTablePublication> publications)	Setter for publications
void	validate(QInstance qInstance, QTableMetaData tableMetaData, QInstanceValidator qInstanceValidator)	Each publication must be to a known destination.
EsbTableMetaData	withPublication(EsbTablePublication publication)	Fluent setter to add a single publication
EsbTableMetaData	withPublications(List<EsbTablePublication> publications)	Fluent setter for publications

Methods inherited from class com.kingsrook.qqq.backend.core.model.metadata.tables.QSupplementalTableMetaData

clone, enrich, of, ofOrWithNew

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

EsbTableMetaData

public EsbTableMetaData()

Method Details

of

public static EsbTableMetaData of(QTableMetaData table)

Get the ESB meta-data on a table - or null if it has none.

ofOrWithNew

public static EsbTableMetaData ofOrWithNew(QTableMetaData table)

Get the ESB meta-data on a table - creating (and adding) it if the table doesn't have any yet.

getType

public String getType()

Description copied from class: QSupplementalTableMetaData

Getter for type

Specified by:

getType in class QSupplementalTableMetaData

includeInPartialFrontendMetaData

public boolean includeInPartialFrontendMetaData()

Overrides:

includeInPartialFrontendMetaData in class QSupplementalTableMetaData

includeInFullFrontendMetaData

public boolean includeInFullFrontendMetaData()

Overrides:

includeInFullFrontendMetaData in class QSupplementalTableMetaData

validate

public void validate(QInstance qInstance,
 QTableMetaData tableMetaData,
 QInstanceValidator qInstanceValidator)

Each publication must be to a known destination.

Overrides:

validate in class QSupplementalTableMetaData

finishClone

protected EsbTableMetaData finishClone(QSupplementalTableMetaData abstractClone)

Description copied from class: QSupplementalTableMetaData

finish the cloning operation started in the base class. copy all state from the subclass into the input clone (which can be safely casted to the subclass's type, as it was obtained by super.clone()) Rather than making this public and breaking all existing implementations that don't have it - we're making it protected, with a one-time warning if it isn't implemented in a subclass.

Overrides:

finishClone in class QSupplementalTableMetaData

getPublications

public List<EsbTablePublication> getPublications()

Getter for publications

setPublications

public void setPublications(List<EsbTablePublication> publications)

Setter for publications

withPublications

public EsbTableMetaData withPublications(List<EsbTablePublication> publications)

Fluent setter for publications

withPublication

public EsbTableMetaData withPublication(EsbTablePublication publication)

Fluent setter to add a single publication