planetj.exception
Class AlterationLWO

java.lang.Object
  |
  +--planetj.exception.AlterationLWO

public class AlterationLWO

extends Object

Contains information about a value that has been altered.

Author:

Justin Epstein, PlanetJ Corp.

Field Summary

static byte	DELETE_ALTERATION
static byte	UNKNOWN_TYPE
static byte	UPDATE_ALTERATION

Constructor Summary

AlterationLWO()
ModificationLWO constructor comment.

AlterationLWO(String fieldName, Object currentValue, Object originalValue, Object desiredValue, byte alterationType)
Creates a new AlterationLWO with initial values.

Method Summary

byte	getAlterationType() Gets the type of alteration that took place.
Object	getCurrentValue() Gets the value of the field that is currently in the data source.
Object	getDesiredValue() Gets the value the field was going to be set to (but wasn't since another user had modified it).
String	getFieldName() Gets the name of the field to which an alteration attempt was made.
Object	getOriginalValue() Gets the value of the field the last time we read it.
void	setAlterationType(byte newAlterationType) Sets the type of alteration that took place.
void	setCurrentValue(Object newCurrentValue) Sets the value of the field that is currently in the data source.
void	setDesiredValue(Object newDesiredValue) Sets the value the field was going to be set to (but wasn't since another user had modified it).
void	setFieldName(String newFieldName) Sets the name of the field to which an alteration attempt was made.
void	setOriginalValue(Object newOriginalValue) Sets the value of the field the last time we read it.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_TYPE

public static final byte UNKNOWN_TYPE

See Also:

Constant Field Values

DELETE_ALTERATION

public static final byte DELETE_ALTERATION

See Also:

Constant Field Values

UPDATE_ALTERATION

public static final byte UPDATE_ALTERATION

See Also:

Constant Field Values

Constructor Detail

AlterationLWO

public AlterationLWO()

ModificationLWO constructor comment.

AlterationLWO

public AlterationLWO(String fieldName,
                     Object currentValue,
                     Object originalValue,
                     Object desiredValue,
                     byte alterationType)

Creates a new AlterationLWO with initial values.

Method Detail

getAlterationType

public byte getAlterationType()

Gets the type of alteration that took place.

getCurrentValue

public Object getCurrentValue()

Gets the value of the field that is currently in the data source. This may be null.

getDesiredValue

public Object getDesiredValue()

Gets the value the field was going to be set to (but wasn't since another user had modified it). This may be null.

getFieldName

public String getFieldName()

Gets the name of the field to which an alteration attempt was made.

getOriginalValue

public Object getOriginalValue()

Gets the value of the field the last time we read it. This is what we expected its current value to be. This may be null.

setAlterationType

public void setAlterationType(byte newAlterationType)

Sets the type of alteration that took place.

setCurrentValue

public void setCurrentValue(Object newCurrentValue)

Sets the value of the field that is currently in the data source.

setDesiredValue

public void setDesiredValue(Object newDesiredValue)

Sets the value the field was going to be set to (but wasn't since another user had modified it).

setFieldName

public void setFieldName(String newFieldName)

Sets the name of the field to which an alteration attempt was made.

setOriginalValue

public void setOriginalValue(Object newOriginalValue)

Sets the value of the field the last time we read it. This is what we expected its current value to be.