lumis.portal.serialization.operation
Class ConfigForeignKey

java.lang.Object
  lumis.portal.serialization.operation.ConfigForeignKey

public class ConfigForeignKey
extends Object

Represents a foreign key (field) of a portal object

Since:

4.0.9

Constructor Summary

ConfigForeignKey(String name)
Constructs a ConfigForeignKey that references an object that has certainly already persisted and, in this case, does not have to be analyzed.

ConfigForeignKey(String name, String violationValue, boolean persistIfViolated, boolean abortIfViolated, boolean mutable, IConfigKeyChecker checker)
Constructs a ConfigForeignKey that references an object that could not be already persisted and, in this case, has to be analyzed.

Method Summary

boolean	getAbortIfViolated()
IConfigKeyChecker	getChecker()
String	getName()
boolean	getPersistIfViolated()
String	getViolationValue()
boolean	isMutable()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigForeignKey

public ConfigForeignKey(String name,
                        String violationValue,
                        boolean persistIfViolated,
                        boolean abortIfViolated,
                        boolean mutable,
                        IConfigKeyChecker checker)

Constructs a ConfigForeignKey that references an object that could not be already persisted and, in this case, has to be analyzed.

Parameters:

name - Config field name

violationValue - If the original value represents a violated foreign key, this value will be used to generate a persistable Config object.

persistIfViolated - The generated persistable Config object can be persisted, if the original value represents a violated foreign key.

abortIfViolated - The deserialization process must be aborted at the end, if the original value represents a violated foreign key.

mutable - The field can be mapped to a new value. e.g. channelId is a mutable value, while a serviceId is not mutable.

checker - IConfigKeyChecker implementation that checks if the foreign key value is violated.

ConfigForeignKey

public ConfigForeignKey(String name)

Constructs a ConfigForeignKey that references an object that has certainly already persisted and, in this case, does not have to be analyzed.

Parameters:

name - Config field name

Method Detail

getAbortIfViolated

public boolean getAbortIfViolated()

getChecker

public IConfigKeyChecker getChecker()

getName

public String getName()

getPersistIfViolated

public boolean getPersistIfViolated()

isMutable

public boolean isMutable()

getViolationValue

public String getViolationValue()

toString

public String toString()

Overrides:

toString in class Object