org.melati.poem.generated
Class ColumnInfoBase

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.ColumnInfoBase

All Implemented Interfaces:

Cloneable, Persistable, Persistent, Treeable

Direct Known Subclasses:

ColumnInfo

public abstract class ColumnInfoBase
extends ValueInfo

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

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

Field Summary

protected Integer	displaylevel Display level - A category determining what granularity of report the field appears in
protected Integer	displayorder Display order - A rank determining where the field appears in lists
protected Integer	displayorderpriority Display order priority - If present, the level at which lists of records are sorted by the field
protected Integer	id id
protected Boolean	indexed indexed - Whether the field is indexed (ignored if the field is marked `unique')
protected Integer	integrityfix Integrity fix - How referential integrity is maintained, what to do when the object referred to is deleted
protected String	name name - A code-name for the field
protected Integer	searchability searchability - A category determining what level of searching this field supports
protected Boolean	sortdescending Sort Descending - Whether when sorting by this column, the sort order should be reversed
protected Integer	tableinfo Owning table - The table to which the field belongs
protected Boolean	unique unique - Whether the field is unique (implies that it's `indexed')
protected Boolean	usercreateable User-createable - Whether it makes sense for the user to initialise the field's value

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

ColumnInfoBase()

Method Summary

ColumnInfoTable	getColumnInfoTable() Retrieves the ColumnInfoTable table which this Persistent is from.
Integer	getDisplaylevel_unsafe() Retrieves the Displaylevel value, without locking, for this ColumnInfo Persistent.
DisplayLevel	getDisplaylevel() Retrieves the Displaylevel value of this Persistent.
Field	getDisplaylevelField() Retrieves the Displaylevel value as a Field from this ColumnInfo Persistent.
Integer	getDisplaylevelIndex() Retrieves the Displaylevel index value of this Persistent.
Integer	getDisplayorder_unsafe() Retrieves the Displayorder value, without locking, for this ColumnInfo Persistent.
Integer	getDisplayorder() Retrieves the Displayorder value, with locking, for this ColumnInfo Persistent.
Field	getDisplayorderField() Retrieves the Displayorder value as a Field from this ColumnInfo Persistent.
Integer	getDisplayorderpriority_unsafe() Retrieves the Displayorderpriority value, without locking, for this ColumnInfo Persistent.
Integer	getDisplayorderpriority() Retrieves the Displayorderpriority value, with locking, for this ColumnInfo Persistent.
Field	getDisplayorderpriorityField() Retrieves the Displayorderpriority value as a Field from this ColumnInfo Persistent.
Integer	getId_unsafe() Retrieves the Id value, without locking, for this ColumnInfo Persistent.
Integer	getId() Retrieves the Id value, with locking, for this ColumnInfo Persistent.
Field	getIdField() Retrieves the Id value as a Field from this ColumnInfo Persistent.
Boolean	getIndexed_unsafe() Retrieves the Indexed value, without locking, for this ColumnInfo Persistent.
Boolean	getIndexed() Retrieves the Indexed value, with locking, for this ColumnInfo Persistent.
Field	getIndexedField() Retrieves the Indexed value as a Field from this ColumnInfo Persistent.
Integer	getIntegrityfix_unsafe() Retrieves the Integrityfix value, without locking, for this ColumnInfo Persistent.
StandardIntegrityFix	getIntegrityfix() Retrieves the Integrityfix value of this Persistent.
Field	getIntegrityfixField() Retrieves the Integrityfix value as a Field from this ColumnInfo Persistent.
Integer	getIntegrityfixIndex() Retrieves the Integrityfix index value of this Persistent.
String	getName_unsafe() Retrieves the Name value, without locking, for this ColumnInfo Persistent.
String	getName() Retrieves the Name value, with locking, for this ColumnInfo Persistent.
Field	getNameField() Retrieves the Name value as a Field from this ColumnInfo Persistent.
PoemDatabaseTables	getPoemDatabaseTables() Retrieves the Database object.
Integer	getSearchability_unsafe() Retrieves the Searchability value, without locking, for this ColumnInfo Persistent.
Searchability	getSearchability() Retrieves the Searchability value of this Persistent.
Field	getSearchabilityField() Retrieves the Searchability value as a Field from this ColumnInfo Persistent.
Integer	getSearchabilityIndex() Retrieves the Searchability index value of this Persistent.
Boolean	getSortdescending_unsafe() Retrieves the Sortdescending value, without locking, for this ColumnInfo Persistent.
Boolean	getSortdescending() Retrieves the Sortdescending value, with locking, for this ColumnInfo Persistent.
Field	getSortdescendingField() Retrieves the Sortdescending value as a Field from this ColumnInfo Persistent.
Integer	getTableinfo_unsafe() Retrieves the Tableinfo value, without locking, for this ColumnInfo Persistent.
TableInfo	getTableinfo() Retrieves the Tableinfo object referred to.
Field	getTableinfoField() Retrieves the Tableinfo value as a Field from this ColumnInfo Persistent.
Integer	getTableinfoTroid() Retrieves the Table Row Object ID.
Boolean	getUnique_unsafe() Retrieves the Unique value, without locking, for this ColumnInfo Persistent.
Boolean	getUnique() Retrieves the Unique value, with locking, for this ColumnInfo Persistent.
Field	getUniqueField() Retrieves the Unique value as a Field from this ColumnInfo Persistent.
Boolean	getUsercreateable_unsafe() Retrieves the Usercreateable value, without locking, for this ColumnInfo Persistent.
Boolean	getUsercreateable() Retrieves the Usercreateable value, with locking, for this ColumnInfo Persistent.
Field	getUsercreateableField() Retrieves the Usercreateable value as a Field from this ColumnInfo Persistent.
void	setDisplaylevel_unsafe(Integer cooked) Sets the Displaylevel value directly, without checking, for this ColumnInfo Persistent.
void	setDisplaylevel(DisplayLevel cooked) Sets the Displaylevel value, with checking, for the Persistent argument.
void	setDisplaylevelIndex(Integer raw) Sets the Displaylevel index value, with checking, for this Persistent.
void	setDisplayorder_unsafe(Integer cooked) Sets the Displayorder value directly, without checking, for this ColumnInfo Persistent.
void	setDisplayorder(int cooked) Sets the Displayorder value, with checking, for this ColumnInfo Persistent.
void	setDisplayorder(Integer cooked) Sets the Displayorder value, with checking, for this ColumnInfo Persistent.
void	setDisplayorderpriority_unsafe(Integer cooked) Sets the Displayorderpriority value directly, without checking, for this ColumnInfo Persistent.
void	setDisplayorderpriority(int cooked) Sets the Displayorderpriority value, with checking, for this ColumnInfo Persistent.
void	setDisplayorderpriority(Integer cooked) Sets the Displayorderpriority value, with checking, for this ColumnInfo Persistent.
void	setId_unsafe(Integer cooked) Sets the Id value directly, without checking, for this ColumnInfo Persistent.
void	setId(int cooked) Sets the Id value, with checking, for this ColumnInfo Persistent.
void	setId(Integer cooked) Sets the Id value, with checking, for this ColumnInfo Persistent.
void	setIndexed_unsafe(Boolean cooked) Sets the Indexed value directly, without checking, for this ColumnInfo Persistent.
void	setIndexed(boolean cooked) Sets the Indexed value, with checking, from a boolean, for this ColumnInfo Persistent.
void	setIndexed(Boolean cooked) Sets the Indexed value, with checking, for this ColumnInfo Persistent.
void	setIntegrityfix_unsafe(Integer cooked) Sets the Integrityfix value directly, without checking, for this ColumnInfo Persistent.
void	setIntegrityfix(StandardIntegrityFix cooked) Sets the Integrityfix value, with checking, for the Persistent argument.
void	setIntegrityfixIndex(Integer raw) Sets the Integrityfix index value, with checking, for this Persistent.
void	setName_unsafe(String cooked) Sets the Name value directly, without checking, for this ColumnInfo Persistent.
void	setName(String cooked) Sets the Name value, with checking, for this ColumnInfo Persistent.
void	setSearchability_unsafe(Integer cooked) Sets the Searchability value directly, without checking, for this ColumnInfo Persistent.
void	setSearchability(Searchability cooked) Sets the Searchability value, with checking, for the Persistent argument.
void	setSearchabilityIndex(Integer raw) Sets the Searchability index value, with checking, for this Persistent.
void	setSortdescending_unsafe(Boolean cooked) Sets the Sortdescending value directly, without checking, for this ColumnInfo Persistent.
void	setSortdescending(boolean cooked) Sets the Sortdescending value, with checking, from a boolean, for this ColumnInfo Persistent.
void	setSortdescending(Boolean cooked) Sets the Sortdescending value, with checking, for this ColumnInfo Persistent.
void	setTableinfo_unsafe(Integer cooked) Sets the Tableinfo value directly, without checking, for this ColumnInfo Persistent.
void	setTableinfo(TableInfo cooked) Set the Tableinfo.
void	setTableinfoTroid(Integer raw) Sets the Table Row Object ID.
void	setUnique_unsafe(Boolean cooked) Sets the Unique value directly, without checking, for this ColumnInfo Persistent.
void	setUnique(boolean cooked) Sets the Unique value, with checking, from a boolean, for this ColumnInfo Persistent.
void	setUnique(Boolean cooked) Sets the Unique value, with checking, for this ColumnInfo Persistent.
void	setUsercreateable_unsafe(Boolean cooked) Sets the Usercreateable value directly, without checking, for this ColumnInfo Persistent.
void	setUsercreateable(boolean cooked) Sets the Usercreateable value, with checking, from a boolean, for this ColumnInfo Persistent.
void	setUsercreateable(Boolean cooked) Sets the Usercreateable value, with checking, for this ColumnInfo 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

tableinfo

protected Integer tableinfo

Owning table - The table to which the field belongs

name

protected String name

name - A code-name for the field

displayorder

protected Integer displayorder

Display order - A rank determining where the field appears in lists

usercreateable

protected Boolean usercreateable

User-createable - Whether it makes sense for the user to initialise the field's value

displaylevel

protected Integer displaylevel

Display level - A category determining what granularity of report the field appears in

searchability

protected Integer searchability

searchability - A category determining what level of searching this field supports

displayorderpriority

protected Integer displayorderpriority

Display order priority - If present, the level at which lists of records are sorted by the field

sortdescending

protected Boolean sortdescending

Sort Descending - Whether when sorting by this column, the sort order should be reversed

indexed

protected Boolean indexed

indexed - Whether the field is indexed (ignored if the field is marked `unique')

unique

protected Boolean unique

unique - Whether the field is unique (implies that it's `indexed')

integrityfix

protected Integer integrityfix

Integrity fix - How referential integrity is maintained, what to do when the object referred to is deleted

Constructor Detail

ColumnInfoBase

public ColumnInfoBase()

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)

getColumnInfoTable

public ColumnInfoTable getColumnInfoTable()

Retrieves the ColumnInfoTable table which this Persistent is from.

Returns:

the ColumnInfoTable

See Also:

TableDef.generatePersistentBaseJava(java.io.Writer)

getId_unsafe

public Integer getId_unsafe()

Retrieves the Id value, without locking, for this ColumnInfo 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 ColumnInfo 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 ColumnInfo Persistent.

Returns:

the value of the field Id for this ColumnInfo 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 ColumnInfo Persistent.

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 ColumnInfo Persistent.

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 ColumnInfo Persistent.

Returns:

the Integer id

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getTableinfo_unsafe

public Integer getTableinfo_unsafe()

Retrieves the Tableinfo value, without locking, for this ColumnInfo Persistent.

Returns:

the Integer tableinfo

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setTableinfo_unsafe

public void setTableinfo_unsafe(Integer cooked)

Sets the Tableinfo value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getTableinfoTroid

public Integer getTableinfoTroid()
                          throws AccessPoemException

Retrieves the Table Row Object ID.

Returns:

the TROID as an Integer

Throws:

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

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setTableinfoTroid

public void setTableinfoTroid(Integer raw)
                       throws AccessPoemException

Sets the Table Row Object ID.

Parameters:

raw - a Table Row Object Id

Throws:

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

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getTableinfo

public TableInfo getTableinfo()
                       throws AccessPoemException,
                              NoSuchRowPoemException

Retrieves the Tableinfo object referred to.

Returns:

the Tableinfo as a TableInfo

Throws:

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

NoSuchRowPoemException - if the Persistent has yet to be allocated a TROID

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

setTableinfo

public void setTableinfo(TableInfo cooked)
                  throws AccessPoemException

Set the Tableinfo.

Parameters:

cooked - a validated TableInfo

Throws:

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

Generator

org.melati.poem.prepro.ReferenceFieldDef#generateBaseMethods

getTableinfoField

public Field getTableinfoField()
                        throws AccessPoemException

Retrieves the Tableinfo value as a Field from this ColumnInfo Persistent.

Returns:

the Integer tableinfo

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 ColumnInfo 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 ColumnInfo 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 ColumnInfo Persistent. Field description: A code-name for the field

Specified by:

getName in interface Treeable

Overrides:

getName in class JdbcPersistent

Returns:

the value of the field Name for this ColumnInfo 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 ColumnInfo Persistent. Field description: A code-name for the field

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 ColumnInfo Persistent.

Returns:

the String name

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getDisplayorder_unsafe

public Integer getDisplayorder_unsafe()

Retrieves the Displayorder value, without locking, for this ColumnInfo Persistent.

Returns:

the Integer displayorder

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setDisplayorder_unsafe

public void setDisplayorder_unsafe(Integer cooked)

Sets the Displayorder value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getDisplayorder

public Integer getDisplayorder()
                        throws AccessPoemException

Retrieves the Displayorder value, with locking, for this ColumnInfo Persistent. Field description: A rank determining where the field appears in lists

Returns:

the value of the field Displayorder for this ColumnInfo Persistent

Throws:

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

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setDisplayorder

public void setDisplayorder(Integer cooked)
                     throws AccessPoemException,
                            ValidationPoemException

Sets the Displayorder value, with checking, for this ColumnInfo Persistent. Field description: A rank determining where the field appears in lists

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

setDisplayorder

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

Sets the Displayorder value, with checking, for this ColumnInfo Persistent. Field description: A rank determining where the field appears in lists

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

getDisplayorderField

public Field getDisplayorderField()
                           throws AccessPoemException

Retrieves the Displayorder value as a Field from this ColumnInfo Persistent.

Returns:

the Integer displayorder

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getUsercreateable_unsafe

public Boolean getUsercreateable_unsafe()

Retrieves the Usercreateable value, without locking, for this ColumnInfo Persistent.

Returns:

the Boolean usercreateable

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setUsercreateable_unsafe

public void setUsercreateable_unsafe(Boolean cooked)

Sets the Usercreateable value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getUsercreateable

public Boolean getUsercreateable()
                          throws AccessPoemException

Retrieves the Usercreateable value, with locking, for this ColumnInfo Persistent. Field description: Whether it makes sense for the user to initialise the field's value

Returns:

the value of the field Usercreateable for this ColumnInfo Persistent

Throws:

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

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setUsercreateable

public void setUsercreateable(Boolean cooked)
                       throws AccessPoemException,
                              ValidationPoemException

Sets the Usercreateable value, with checking, for this ColumnInfo Persistent. Field description: Whether it makes sense for the user to initialise the field's value

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

setUsercreateable

public final void setUsercreateable(boolean cooked)
                             throws AccessPoemException,
                                    ValidationPoemException

Sets the Usercreateable value, with checking, from a boolean, for this ColumnInfo Persistent. Field description: Whether it makes sense for the user to initialise the field's value

Parameters:

cooked - a boolean

Throws:

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

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods

getUsercreateableField

public Field getUsercreateableField()
                             throws AccessPoemException

Retrieves the Usercreateable value as a Field from this ColumnInfo Persistent.

Returns:

the Boolean usercreateable

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getDisplaylevel_unsafe

public Integer getDisplaylevel_unsafe()

Retrieves the Displaylevel value, without locking, for this ColumnInfo Persistent.

Returns:

the Integer displaylevel

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setDisplaylevel_unsafe

public void setDisplaylevel_unsafe(Integer cooked)

Sets the Displaylevel value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getDisplaylevelIndex

public Integer getDisplaylevelIndex()
                             throws AccessPoemException

Retrieves the Displaylevel index value of this Persistent. Field description: A category determining what granularity of report the field appears in

Returns:

the Integer displaylevel

Throws:

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

Generator

org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods

setDisplaylevelIndex

public void setDisplaylevelIndex(Integer raw)
                          throws AccessPoemException

Sets the Displaylevel index value, with checking, for this Persistent. Field description: A category determining what granularity of report the field appears in

Parameters:

raw - the value to set

Throws:

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

Generator

org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods

getDisplaylevel

public DisplayLevel getDisplaylevel()
                             throws AccessPoemException

Retrieves the Displaylevel value of this Persistent. Field description: A category determining what granularity of report the field appears in

Returns:

the DisplayLevel

Throws:

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

Generator

org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods

setDisplaylevel

public void setDisplaylevel(DisplayLevel cooked)
                     throws AccessPoemException

Sets the Displaylevel value, with checking, for the Persistent argument. Field description: A category determining what granularity of report the field appears in

Parameters:

cooked - the value to set

Throws:

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

Generator

org.melati.poem.prepro.DisplayLevelFieldDef#generateBaseMethods

getDisplaylevelField

public Field getDisplaylevelField()
                           throws AccessPoemException

Retrieves the Displaylevel value as a Field from this ColumnInfo Persistent.

Returns:

the Integer displaylevel

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getSearchability_unsafe

public Integer getSearchability_unsafe()

Retrieves the Searchability value, without locking, for this ColumnInfo Persistent.

Returns:

the Integer searchability

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setSearchability_unsafe

public void setSearchability_unsafe(Integer cooked)

Sets the Searchability value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getSearchabilityIndex

public Integer getSearchabilityIndex()
                              throws AccessPoemException

Retrieves the Searchability index value of this Persistent. Field description: A category determining what level of searching this field supports

Returns:

the Integer searchability

Throws:

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

Generator

org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods

setSearchabilityIndex

public void setSearchabilityIndex(Integer raw)
                           throws AccessPoemException

Sets the Searchability index value, with checking, for this Persistent. Field description: A category determining what level of searching this field supports

Parameters:

raw - the value to set

Throws:

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

Generator

org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods

getSearchability

public Searchability getSearchability()
                               throws AccessPoemException

Retrieves the Searchability value of this Persistent. Field description: A category determining what level of searching this field supports

Returns:

the Searchability

Throws:

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

Generator

org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods

setSearchability

public void setSearchability(Searchability cooked)
                      throws AccessPoemException

Sets the Searchability value, with checking, for the Persistent argument. Field description: A category determining what level of searching this field supports

Parameters:

cooked - the value to set

Throws:

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

Generator

org.melati.poem.prepro.SearchabiltyFieldDef#generateBaseMethods

getSearchabilityField

public Field getSearchabilityField()
                            throws AccessPoemException

Retrieves the Searchability value as a Field from this ColumnInfo Persistent.

Returns:

the Integer searchability

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getDisplayorderpriority_unsafe

public Integer getDisplayorderpriority_unsafe()

Retrieves the Displayorderpriority value, without locking, for this ColumnInfo Persistent.

Returns:

the Integer displayorderpriority

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setDisplayorderpriority_unsafe

public void setDisplayorderpriority_unsafe(Integer cooked)

Sets the Displayorderpriority value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getDisplayorderpriority

public Integer getDisplayorderpriority()
                                throws AccessPoemException

Retrieves the Displayorderpriority value, with locking, for this ColumnInfo Persistent. Field description: If present, the level at which lists of records are sorted by the field

Returns:

the value of the field Displayorderpriority for this ColumnInfo Persistent

Throws:

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

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setDisplayorderpriority

public void setDisplayorderpriority(Integer cooked)
                             throws AccessPoemException,
                                    ValidationPoemException

Sets the Displayorderpriority value, with checking, for this ColumnInfo Persistent. Field description: If present, the level at which lists of records are sorted by the field

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

setDisplayorderpriority

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

Sets the Displayorderpriority value, with checking, for this ColumnInfo Persistent. Field description: If present, the level at which lists of records are sorted by the field

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

getDisplayorderpriorityField

public Field getDisplayorderpriorityField()
                                   throws AccessPoemException

Retrieves the Displayorderpriority value as a Field from this ColumnInfo Persistent.

Returns:

the Integer displayorderpriority

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getSortdescending_unsafe

public Boolean getSortdescending_unsafe()

Retrieves the Sortdescending value, without locking, for this ColumnInfo Persistent.

Returns:

the Boolean sortdescending

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setSortdescending_unsafe

public void setSortdescending_unsafe(Boolean cooked)

Sets the Sortdescending value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getSortdescending

public Boolean getSortdescending()
                          throws AccessPoemException

Retrieves the Sortdescending value, with locking, for this ColumnInfo Persistent. Field description: Whether when sorting by this column, the sort order should be reversed

Returns:

the value of the field Sortdescending for this ColumnInfo Persistent

Throws:

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

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setSortdescending

public void setSortdescending(Boolean cooked)
                       throws AccessPoemException,
                              ValidationPoemException

Sets the Sortdescending value, with checking, for this ColumnInfo Persistent. Field description: Whether when sorting by this column, the sort order should be reversed

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

setSortdescending

public final void setSortdescending(boolean cooked)
                             throws AccessPoemException,
                                    ValidationPoemException

Sets the Sortdescending value, with checking, from a boolean, for this ColumnInfo Persistent. Field description: Whether when sorting by this column, the sort order should be reversed

Parameters:

cooked - a boolean

Throws:

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

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods

getSortdescendingField

public Field getSortdescendingField()
                             throws AccessPoemException

Retrieves the Sortdescending value as a Field from this ColumnInfo Persistent.

Returns:

the Boolean sortdescending

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getIndexed_unsafe

public Boolean getIndexed_unsafe()

Retrieves the Indexed value, without locking, for this ColumnInfo Persistent.

Returns:

the Boolean indexed

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setIndexed_unsafe

public void setIndexed_unsafe(Boolean cooked)

Sets the Indexed value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getIndexed

public Boolean getIndexed()
                   throws AccessPoemException

Retrieves the Indexed value, with locking, for this ColumnInfo Persistent. Field description: Whether the field is indexed (ignored if the field is marked `unique')

Returns:

the value of the field Indexed for this ColumnInfo Persistent

Throws:

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

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setIndexed

public void setIndexed(Boolean cooked)
                throws AccessPoemException,
                       ValidationPoemException

Sets the Indexed value, with checking, for this ColumnInfo Persistent. Field description: Whether the field is indexed (ignored if the field is marked `unique')

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

setIndexed

public final void setIndexed(boolean cooked)
                      throws AccessPoemException,
                             ValidationPoemException

Sets the Indexed value, with checking, from a boolean, for this ColumnInfo Persistent. Field description: Whether the field is indexed (ignored if the field is marked `unique')

Parameters:

cooked - a boolean

Throws:

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

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods

getIndexedField

public Field getIndexedField()
                      throws AccessPoemException

Retrieves the Indexed value as a Field from this ColumnInfo Persistent.

Returns:

the Boolean indexed

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getUnique_unsafe

public Boolean getUnique_unsafe()

Retrieves the Unique value, without locking, for this ColumnInfo Persistent.

Returns:

the Boolean unique

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setUnique_unsafe

public void setUnique_unsafe(Boolean cooked)

Sets the Unique value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getUnique

public Boolean getUnique()
                  throws AccessPoemException

Retrieves the Unique value, with locking, for this ColumnInfo Persistent. Field description: Whether the field is unique (implies that it's `indexed')

Returns:

the value of the field Unique for this ColumnInfo Persistent

Throws:

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

Generator

org.melati.poem.prepro.AtomFieldDef#generateBaseMethods

setUnique

public void setUnique(Boolean cooked)
               throws AccessPoemException,
                      ValidationPoemException

Sets the Unique value, with checking, for this ColumnInfo Persistent. Field description: Whether the field is unique (implies that it's `indexed')

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

setUnique

public final void setUnique(boolean cooked)
                     throws AccessPoemException,
                            ValidationPoemException

Sets the Unique value, with checking, from a boolean, for this ColumnInfo Persistent. Field description: Whether the field is unique (implies that it's `indexed')

Parameters:

cooked - a boolean

Throws:

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

ValidationPoemException - if the value is not valid

Generator

org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods

getUniqueField

public Field getUniqueField()
                     throws AccessPoemException

Retrieves the Unique value as a Field from this ColumnInfo Persistent.

Returns:

the Boolean unique

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)

getIntegrityfix_unsafe

public Integer getIntegrityfix_unsafe()

Retrieves the Integrityfix value, without locking, for this ColumnInfo Persistent.

Returns:

the Integer integrityfix

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

setIntegrityfix_unsafe

public void setIntegrityfix_unsafe(Integer cooked)

Sets the Integrityfix value directly, without checking, for this ColumnInfo Persistent.

Parameters:

cooked - the pre-validated value to set

See Also:

FieldDef.generateBaseMethods(java.io.Writer)

getIntegrityfixIndex

public Integer getIntegrityfixIndex()
                             throws AccessPoemException

Retrieves the Integrityfix index value of this Persistent. Field description: How referential integrity is maintained, what to do when the object referred to is deleted

Returns:

the Integer integrityfix

Throws:

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

Generator

org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods

setIntegrityfixIndex

public void setIntegrityfixIndex(Integer raw)
                          throws AccessPoemException

Sets the Integrityfix index value, with checking, for this Persistent. Field description: How referential integrity is maintained, what to do when the object referred to is deleted

Parameters:

raw - the value to set

Throws:

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

Generator

org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods

getIntegrityfix

public StandardIntegrityFix getIntegrityfix()
                                     throws AccessPoemException

Retrieves the Integrityfix value of this Persistent. Field description: How referential integrity is maintained, what to do when the object referred to is deleted

Returns:

the StandardIntegrityFix

Throws:

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

Generator

org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods

setIntegrityfix

public void setIntegrityfix(StandardIntegrityFix cooked)
                     throws AccessPoemException

Sets the Integrityfix value, with checking, for the Persistent argument. Field description: How referential integrity is maintained, what to do when the object referred to is deleted

Parameters:

cooked - the value to set

Throws:

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

Generator

org.melati.poem.prepro.IntegrityFixFieldDef#generateBaseMethods

getIntegrityfixField

public Field getIntegrityfixField()
                           throws AccessPoemException

Retrieves the Integrityfix value as a Field from this ColumnInfo Persistent.

Returns:

the Integer integrityfix

Throws:

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

See Also:

FieldDef.generateFieldCreator(java.io.Writer)