org.melati.poem.generated
Class SettingBase

java.lang.Object
  org.melati.poem.transaction.Transactioned
      org.melati.poem.JdbcPersistent
          org.melati.poem.generated.ValueInfoBase
              org.melati.poem.ValueInfo
                  org.melati.poem.generated.SettingBase

All Implemented Interfaces:

Cloneable, Persistable, Persistent, Treeable

Direct Known Subclasses:

Setting

public abstract class SettingBase
extends ValueInfo

Melati POEM generated abstract base class for a Persistent Setting Object.

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

Field Summary

protected Integer	id id - The Table Row Object ID
protected String	name name - A code name for this setting
protected String	value value - The value of this setting

Fields inherited from class org.melati.poem.generated.ValueInfoBase

description, displayname, height, nullable, precision, rangelimit_string, rangelow_string, renderinfo, scale, size, typefactory, usereditable, width

Fields inherited from class org.melati.poem.transaction.Transactioned

valid

Constructor Summary

SettingBase()

Method Summary

Integer	getId_unsafe() Retrieves the Id value, without locking, for this Setting Persistent.
Integer	getId() Retrieves the Id value, with locking, for this Setting Persistent.
Field	getIdField() Retrieves the Id value as a Field from this Setting Persistent.
String	getName_unsafe() Retrieves the Name value, without locking, for this Setting Persistent.
String	getName() Retrieves the Name value, with locking, for this Setting Persistent.
Field	getNameField() Retrieves the Name value as a Field from this Setting Persistent.
PoemDatabaseTables	getPoemDatabaseTables() Retrieves the Database object.
SettingTable	getSettingTable() Retrieves the SettingTable table which this Persistent is from.
String	getValue_unsafe() Retrieves the Value value, without locking, for this Setting Persistent.
String	getValue() Retrieves the Value value, with locking, for this Setting Persistent.
Field	getValueField() Retrieves the Value value as a Field from this Setting Persistent.
void	setId_unsafe(Integer cooked) Sets the Id value directly, without checking, for this Setting Persistent.
void	setId(int cooked) Sets the Id value, with checking, for this Setting Persistent.
void	setId(Integer cooked) Sets the Id value, with checking, for this Setting Persistent.
void	setName_unsafe(String cooked) Sets the Name value directly, without checking, for this Setting Persistent.
void	setName(String cooked) Sets the Name value, with checking, for this Setting Persistent.
void	setValue_unsafe(String cooked) Sets the Value value directly, without checking, for this Setting Persistent.
void	setValue(String cooked) Sets the Value value, with checking, for this Setting Persistent.

Methods inherited from class org.melati.poem.ValueInfo

fieldAttributesRenamedAs, getRangelimit_stringField, getRangelow_stringField, getType, setRangelimit_string, setRangelow_string, toTypeParameter

Methods inherited from class org.melati.poem.generated.ValueInfoBase

getDescription_unsafe, getDescription, getDescriptionField, getDisplayname_unsafe, getDisplayname, getDisplaynameField, getHeight_unsafe, getHeight, getHeightField, getNullable_unsafe, getNullable, getNullableField, getPrecision_unsafe, getPrecision, getPrecisionField, getRangelimit_string_unsafe, getRangelimit_string, getRangelow_string_unsafe, getRangelow_string, getRenderinfo_unsafe, getRenderinfo, getRenderinfoField, getScale_unsafe, getScale, getScaleField, getSize_unsafe, getSize, getSizeField, getTypefactory_unsafe, getTypefactory, getTypefactoryCode, getTypefactoryField, getUsereditable_unsafe, getUsereditable, getUsereditableField, getValueInfoTable, getWidth_unsafe, getWidth, getWidthField, setDescription_unsafe, setDescription, setDisplayname_unsafe, setDisplayname, setHeight_unsafe, setHeight, setHeight, setNullable_unsafe, setNullable, setNullable, setPrecision_unsafe, setPrecision, setPrecision, setRangelimit_string_unsafe, setRangelow_string_unsafe, setRenderinfo_unsafe, setRenderinfo, setScale_unsafe, setScale, setScale, setSize_unsafe, setSize, setSize, setTypefactory_unsafe, setTypefactory, setTypefactoryCode, setUsereditable_unsafe, setUsereditable, setUsereditable, setWidth_unsafe, setWidth, setWidth

Methods inherited from class org.melati.poem.JdbcPersistent

assertCanCreate, assertCanCreate, assertCanDelete, assertCanDelete, assertCanRead, assertCanRead, assertCanWrite, assertCanWrite, clone, commit, countMatchSQL, delete_unsafe, delete, delete, deleteAndCommit, deleteAndCommit, deleteLock, displayString, displayString, displayString, dump, dump, duplicated, duplicatedFloating, equals, existenceLock, existenceLock, fieldsOfColumns, fromClause, getCanDelete, getCanRead, getCanSelect, getCanWrite, getChildren, getCooked, getCookedString, getDatabase, getDetailDisplayFields, getField, getFields, getPrimaryDisplayField, getRaw, getRawString, getReadable, getRecordDisplayFields, getSearchCriterionFields, getSummaryDisplayFields, getTable, getTroid, hashCode, invalidate, isDirty, load, makePersistent, postEdit, postInsert, postModify, postWrite, preEdit, readLock, readLock, readLock, rollback, setCooked, setDirty, setRaw, setRawString, statusExistent, statusNonexistent, toString, troid, upToDate, writeDown, writeLock, writeLock, writeLock

Methods inherited from class org.melati.poem.transaction.Transactioned

markValid, reset, setTransactionPool, transactionPool, unSee

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected Integer id

id - The Table Row Object ID

name

protected String name

name - A code name for this setting

value

protected String value

value - The value of this setting

Constructor Detail

SettingBase

public SettingBase()

Method Detail

getPoemDatabaseTables

public PoemDatabaseTables getPoemDatabaseTables()

Retrieves the Database object.

Overrides:

getPoemDatabaseTables in class ValueInfoBase

Returns:

the database

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

getSettingTable

public SettingTable getSettingTable()

Retrieves the SettingTable table which this Persistent is from.

Returns:

the SettingTable

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

getId_unsafe

public Integer getId_unsafe()

Retrieves the Id value, without locking, for this Setting Persistent.

Returns:

the Integer id

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setId_unsafe

public void setId_unsafe(Integer cooked)

Sets the Id value directly, without checking, for this Setting Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getId

public Integer getId()
              throws AccessPoemException

Retrieves the Id value, with locking, for this Setting Persistent. Field description: The Table Row Object ID

Returns:

the value of the field Id for this Setting Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setId

public void setId(Integer cooked)
           throws AccessPoemException,
                  ValidationPoemException

Sets the Id value, with checking, for this Setting Persistent. Field description: The Table Row Object ID

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setId

public final void setId(int cooked)
                 throws AccessPoemException,
                        ValidationPoemException

Sets the Id value, with checking, for this Setting Persistent. Field description: The Table Row Object ID

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods

getIdField

public Field getIdField()
                 throws AccessPoemException

Retrieves the Id value as a Field from this Setting Persistent.

Returns:

the Integer id

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getName_unsafe

public String getName_unsafe()

Retrieves the Name value, without locking, for this Setting Persistent.

Returns:

the String name

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setName_unsafe

public void setName_unsafe(String cooked)

Sets the Name value directly, without checking, for this Setting Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getName

public String getName()
               throws AccessPoemException

Retrieves the Name value, with locking, for this Setting Persistent. Field description: A code name for this setting

Specified by:

getName in interface Treeable

Overrides:

getName in class JdbcPersistent

Returns:

the value of the field Name for this Setting Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

Treeable.getName()

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setName

public void setName(String cooked)
             throws AccessPoemException,
                    ValidationPoemException

Sets the Name value, with checking, for this Setting Persistent. Field description: A code name for this setting

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

getNameField

public Field getNameField()
                   throws AccessPoemException

Retrieves the Name value as a Field from this Setting Persistent.

Returns:

the String name

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getValue_unsafe

public String getValue_unsafe()

Retrieves the Value value, without locking, for this Setting Persistent.

Returns:

the String value

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setValue_unsafe

public void setValue_unsafe(String cooked)

Sets the Value value directly, without checking, for this Setting Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getValue

public String getValue()
                throws AccessPoemException

Retrieves the Value value, with locking, for this Setting Persistent. Field description: The value of this setting

Returns:

the value of the field Value for this Setting Persistent

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setValue

public void setValue(String cooked)
              throws AccessPoemException,
                     ValidationPoemException

Sets the Value value, with checking, for this Setting Persistent. Field description: The value of this setting

Parameters:

cooked - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

getValueField

public Field getValueField()
                    throws AccessPoemException

Retrieves the Value value as a Field from this Setting Persistent.

Returns:

the String value

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

FieldDef.generateFieldCreator(java.io.Writer)