org.jaffa.rules.examples.domain
Class ValidFieldValue

java.lang.Object
  org.jaffa.persistence.Persistent
      org.jaffa.rules.examples.domain.ValidFieldValue

All Implemented Interfaces:

Cloneable, IPersistent, Serializable

public class ValidFieldValue

extends Persistent

Auto Generated Persistent class for the VALID_FIELD_VALUE table.

Author:

Auto-Generated

See Also:

Serialized Form

Constructor Summary

ValidFieldValue()

Method Summary

Object	clone() Returns a clone of the object.
static boolean	exists(UOW uow, String tableName, String fieldName, String legalValue) Check if the domain object exists for the input Primary Key.
static ValidFieldValue	findByPK(UOW uow, String tableName, String fieldName, String legalValue) Returns the domain object for the input Primary Key.
static Criteria	findByPKCriteria(String tableName, String fieldName, String legalValue) Returns a Criteria object for retrieving the domain object based on the input Primary Key.
String	getDescription() Getter for property description.
String	getFieldName() Getter for property fieldName.
String	getLegalValue() Getter for property legalValue.
String	getRemarks() Getter for property remarks.
String	getTableName() Getter for property tableName.
void	performForeignKeyValidations() This method ensures that the modified foreign-keys are valid.
void	performPreDeleteReferentialIntegrity() This method is triggered by the UOW, before adding this object to the Delete-Store.
void	setDescription(String description) Use this method to update the property description.
void	setFieldName(String fieldName) Use this method to update the property fieldName.
void	setLegalValue(String legalValue) Use this method to update the property legalValue.
void	setRemarks(String remarks) Use this method to update the property remarks.
void	setTableName(String tableName) Use this method to update the property tableName.
String	toString() This returns the diagnostic information.
void	updateDescription(String description) This method is present for backwards compatibility only.
void	updateFieldName(String fieldName) This method is present for backwards compatibility only.
void	updateLegalValue(String legalValue) This method is present for backwards compatibility only.
void	updateRemarks(String remarks) This method is present for backwards compatibility only.
void	updateTableName(String tableName) This method is present for backwards compatibility only.
String	validateDescription(String description) Use this method to validate a value for the property description.
String	validateFieldName(String fieldName) Use this method to validate a value for the property fieldName.
String	validateLegalValue(String legalValue) Use this method to validate a value for the property legalValue.
String	validateRemarks(String remarks) Use this method to validate a value for the property remarks.
String	validateTableName(String tableName) Use this method to validate a value for the property tableName.

Methods inherited from class org.jaffa.persistence.Persistent

actualInstance, addInitialValue, getLocking, getUOW, isDatabaseOccurence, isLocked, isModified, isModified, isQueued, postAdd, postDelete, postLoad, postUpdate, preAdd, preDelete, preUpdate, returnInitialValue, setDatabaseOccurence, setLocked, setLocking, setModified, setQueued, setUOW, update

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidFieldValue

public ValidFieldValue()

Method Detail

exists

public static boolean exists(UOW uow,
                             String tableName,
                             String fieldName,
                             String legalValue)
                      throws FrameworkException

Check if the domain object exists for the input Primary Key.

Returns:

true if the domain object exists for the input Primary Key.

Throws:

FrameworkException - Indicates some system error

findByPK

public static ValidFieldValue findByPK(UOW uow,
                                       String tableName,
                                       String fieldName,
                                       String legalValue)
                                throws FrameworkException

Returns the domain object for the input Primary Key.

Returns:

the domain object for the input Primary Key. A null is returned if the domain object is not found.

Throws:

FrameworkException - Indicates some system error

findByPKCriteria

public static Criteria findByPKCriteria(String tableName,
                                        String fieldName,
                                        String legalValue)

Returns a Criteria object for retrieving the domain object based on the input Primary Key.

Returns:

a Criteria object for retrieving the domain object based on the input Primary Key.

getTableName

public String getTableName()

Getter for property tableName.

Returns:

Value of property tableName.

setTableName

public void setTableName(String tableName)
                  throws ValidationException,
                         UpdatePrimaryKeyException,
                         ReadOnlyObjectException,
                         AlreadyLockedObjectException,
                         FrameworkException

Use this method to update the property tableName. This method will do nothing and simply return if the input value is the same as the current value. Validation will be performed on the input value. This will try to lock the underlying database row, in case CAUTIOUS locking is specified at the time of query.

Parameters:

tableName - New value of property tableName.

Throws:

ValidationException - if an invalid value is passed.

UpdatePrimaryKeyException - if this domain object was loaded from the database.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

updateTableName

public void updateTableName(String tableName)
                     throws ValidationException,
                            UpdatePrimaryKeyException,
                            ReadOnlyObjectException,
                            AlreadyLockedObjectException,
                            FrameworkException

This method is present for backwards compatibility only. It merely invokes the setTableName() method.

Parameters:

tableName - New value of property tableName.

Throws:

ValidationException - if an invalid value is passed.

UpdatePrimaryKeyException - if this domain object was loaded from the database.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

validateTableName

public String validateTableName(String tableName)
                         throws ValidationException,
                                FrameworkException

Use this method to validate a value for the property tableName.

Parameters:

tableName - Value to be validated for the property tableName.

Throws:

ValidationException - if an invalid value is passed

FrameworkException - Indicates some system error

getFieldName

public String getFieldName()

Getter for property fieldName.

Returns:

Value of property fieldName.

setFieldName

public void setFieldName(String fieldName)
                  throws ValidationException,
                         UpdatePrimaryKeyException,
                         ReadOnlyObjectException,
                         AlreadyLockedObjectException,
                         FrameworkException

Use this method to update the property fieldName. This method will do nothing and simply return if the input value is the same as the current value. Validation will be performed on the input value. This will try to lock the underlying database row, in case CAUTIOUS locking is specified at the time of query.

Parameters:

fieldName - New value of property fieldName.

Throws:

ValidationException - if an invalid value is passed.

UpdatePrimaryKeyException - if this domain object was loaded from the database.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

updateFieldName

public void updateFieldName(String fieldName)
                     throws ValidationException,
                            UpdatePrimaryKeyException,
                            ReadOnlyObjectException,
                            AlreadyLockedObjectException,
                            FrameworkException

This method is present for backwards compatibility only. It merely invokes the setFieldName() method.

Parameters:

fieldName - New value of property fieldName.

Throws:

ValidationException - if an invalid value is passed.

UpdatePrimaryKeyException - if this domain object was loaded from the database.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

validateFieldName

public String validateFieldName(String fieldName)
                         throws ValidationException,
                                FrameworkException

Use this method to validate a value for the property fieldName.

Parameters:

fieldName - Value to be validated for the property fieldName.

Throws:

ValidationException - if an invalid value is passed

FrameworkException - Indicates some system error

getLegalValue

public String getLegalValue()

Getter for property legalValue.

Returns:

Value of property legalValue.

setLegalValue

public void setLegalValue(String legalValue)
                   throws ValidationException,
                          UpdatePrimaryKeyException,
                          ReadOnlyObjectException,
                          AlreadyLockedObjectException,
                          FrameworkException

Use this method to update the property legalValue. This method will do nothing and simply return if the input value is the same as the current value. Validation will be performed on the input value. This will try to lock the underlying database row, in case CAUTIOUS locking is specified at the time of query.

Parameters:

legalValue - New value of property legalValue.

Throws:

ValidationException - if an invalid value is passed.

UpdatePrimaryKeyException - if this domain object was loaded from the database.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

updateLegalValue

public void updateLegalValue(String legalValue)
                      throws ValidationException,
                             UpdatePrimaryKeyException,
                             ReadOnlyObjectException,
                             AlreadyLockedObjectException,
                             FrameworkException

This method is present for backwards compatibility only. It merely invokes the setLegalValue() method.

Parameters:

legalValue - New value of property legalValue.

Throws:

ValidationException - if an invalid value is passed.

UpdatePrimaryKeyException - if this domain object was loaded from the database.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

validateLegalValue

public String validateLegalValue(String legalValue)
                          throws ValidationException,
                                 FrameworkException

Use this method to validate a value for the property legalValue.

Parameters:

legalValue - Value to be validated for the property legalValue.

Throws:

ValidationException - if an invalid value is passed

FrameworkException - Indicates some system error

getDescription

public String getDescription()

Getter for property description.

Returns:

Value of property description.

setDescription

public void setDescription(String description)
                    throws ValidationException,
                           ReadOnlyObjectException,
                           AlreadyLockedObjectException,
                           FrameworkException

Use this method to update the property description. This method will do nothing and simply return if the input value is the same as the current value. Validation will be performed on the input value. This will try to lock the underlying database row, in case CAUTIOUS locking is specified at the time of query.

Parameters:

description - New value of property description.

Throws:

ValidationException - if an invalid value is passed.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

updateDescription

public void updateDescription(String description)
                       throws ValidationException,
                              ReadOnlyObjectException,
                              AlreadyLockedObjectException,
                              FrameworkException

This method is present for backwards compatibility only. It merely invokes the setDescription() method.

Parameters:

description - New value of property description.

Throws:

ValidationException - if an invalid value is passed.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

validateDescription

public String validateDescription(String description)
                           throws ValidationException,
                                  FrameworkException

Use this method to validate a value for the property description.

Parameters:

description - Value to be validated for the property description.

Throws:

ValidationException - if an invalid value is passed

FrameworkException - Indicates some system error

getRemarks

public String getRemarks()

Getter for property remarks.

Returns:

Value of property remarks.

setRemarks

public void setRemarks(String remarks)
                throws ValidationException,
                       ReadOnlyObjectException,
                       AlreadyLockedObjectException,
                       FrameworkException

Use this method to update the property remarks. This method will do nothing and simply return if the input value is the same as the current value. Validation will be performed on the input value. This will try to lock the underlying database row, in case CAUTIOUS locking is specified at the time of query.

Parameters:

remarks - New value of property remarks.

Throws:

ValidationException - if an invalid value is passed.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

updateRemarks

public void updateRemarks(String remarks)
                   throws ValidationException,
                          ReadOnlyObjectException,
                          AlreadyLockedObjectException,
                          FrameworkException

This method is present for backwards compatibility only. It merely invokes the setRemarks() method.

Parameters:

remarks - New value of property remarks.

Throws:

ValidationException - if an invalid value is passed.

ReadOnlyObjectException - if a Read-Only object is updated.

AlreadyLockedObjectException - if the underlying database row is already locked by another process.

FrameworkException - Indicates some system error

validateRemarks

public String validateRemarks(String remarks)
                       throws ValidationException,
                              FrameworkException

Use this method to validate a value for the property remarks.

Parameters:

remarks - Value to be validated for the property remarks.

Throws:

ValidationException - if an invalid value is passed

FrameworkException - Indicates some system error

toString

public String toString()

This returns the diagnostic information.

Overrides:

toString in class Persistent

Returns:

the diagnostic information.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the object.

Overrides:

clone in class Persistent

Returns:

a clone of the object.

Throws:

CloneNotSupportedException - if cloning is not supported. This should never happen.

performForeignKeyValidations

public void performForeignKeyValidations()
                                  throws ApplicationExceptions,
                                         FrameworkException

This method ensures that the modified foreign-keys are valid.

Overrides:

performForeignKeyValidations in class Persistent

Throws:

ApplicationExceptions - if an invalid foreign key is set.

FrameworkException - Indicates some system error

performPreDeleteReferentialIntegrity

public void performPreDeleteReferentialIntegrity()
                                          throws PreDeleteFailedException

This method is triggered by the UOW, before adding this object to the Delete-Store. This will raise an exception if any associated/aggregated objects exist. This will cascade delete all composite objects.

Overrides:

performPreDeleteReferentialIntegrity in class Persistent

Throws:

PreDeleteFailedException - if any error occurs during the process.