Class ParityExclusions

java.lang.Object

com.kingsrook.qqq.api.actions.ParityExclusions

public class ParityExclusions
extends Object

Explicit, reasoned exceptions to UI/model API parity. Names are core metadata names, not API aliases. Keep a separate exclusions object for each API/version.

Constructor Summary

Constructors

Constructor	Description
ParityExclusions()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getReasons()	Return an immutable copy so a running check cannot consume caller state.
ParityExclusions	withCapability(String tableName, Capability capability, String reason)	Allow a deliberately unavailable operation without excluding the table.
ParityExclusions	withField(String tableName, String fieldName, String reason)	Exclude a physical or virtual field without excluding the rest of its table.
ParityExclusions	withProcess(String processName, String reason)	Exclude a whole process.
ParityExclusions	withTable(String tableName, String reason)	Exclude a whole table, including its fields, permissions and capabilities.

Methods inherited from class java.lang.Object

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

Constructor Details

ParityExclusions

public ParityExclusions()

Method Details

withTable

public ParityExclusions withTable(String tableName,
 String reason)

Exclude a whole table, including its fields, permissions and capabilities.

withProcess

public ParityExclusions withProcess(String processName,
 String reason)

Exclude a whole process.

withField

public ParityExclusions withField(String tableName,
 String fieldName,
 String reason)

Exclude a physical or virtual field without excluding the rest of its table.

withCapability

public ParityExclusions withCapability(String tableName,
 Capability capability,
 String reason)

Allow a deliberately unavailable operation without excluding the table.

getReasons

public Map<String,String> getReasons()

Return an immutable copy so a running check cannot consume caller state.