org.adroitlogic.x.feature.db.models

Class DBConfigVariableParameter

java.lang.Object

org.adroitlogic.x.feature.db.models.AbstractDBConfigParameter

org.adroitlogic.x.feature.db.models.DBConfigVariableParameter

public class DBConfigVariableParameter
extends AbstractDBConfigParameter

Model class for scope variable parameters.

Since:

17.01

Author:

Dulaj Atapattu

Constructor Summary

Constructors

Constructor and Description
DBConfigVariableParameter()

Method Summary

Modifier and Type	Method and Description
Class<?>	getClassName()
Object	getValue(org.adroitlogic.x.api.XMessageContext xMessageContext, Object... args) Returns the actual value to insert to the database for the relevant parameter.
String	getVariableName()
boolean	isParsingRequired() Whether the payload should be parsed to extract parameter values.
boolean	isPropagateToParent()
void	setClassName(Class<?> className)
void	setPropagateToParent(boolean propagateToParent)
void	setVariableName(String variableName)
String	toString()
void	validate() Checks whether the values of the parameter attributes are valid or not.

Methods inherited from class org.adroitlogic.x.feature.db.models.AbstractDBConfigParameter

getName, setName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DBConfigVariableParameter

public DBConfigVariableParameter()

Method Detail

getVariableName

public String getVariableName()

setVariableName

public void setVariableName(String variableName)

getClassName

public Class<?> getClassName()

setClassName

public void setClassName(Class<?> className)

isPropagateToParent

public boolean isPropagateToParent()

setPropagateToParent

public void setPropagateToParent(boolean propagateToParent)

isParsingRequired

public boolean isParsingRequired()

Description copied from class: AbstractDBConfigParameter

Whether the payload should be parsed to extract parameter values.

Specified by:

isParsingRequired in class AbstractDBConfigParameter

Returns:

true - If parsing is required. Else false.

validate

public void validate()

Description copied from class: AbstractDBConfigParameter

Checks whether the values of the parameter attributes are valid or not. This method should be overridden and required implementation should be provided in child classes.

Overrides:

validate in class AbstractDBConfigParameter

getValue

public Object getValue(org.adroitlogic.x.api.XMessageContext xMessageContext,
                       Object... args)

Description copied from class: AbstractDBConfigParameter

Returns the actual value to insert to the database for the relevant parameter.

Specified by:

getValue in class AbstractDBConfigParameter

Parameters:

xMessageContext - XMessageContext instance of the message.

args - Any addition arguments required to extract the value.

Returns:

Value to insert to the database.

toString

public String toString()

Overrides:

toString in class AbstractDBConfigParameter