AbstractPersistentObject (Tentackle Persistence 2.1.2 API)

java.lang.Object
- org.tentackle.dbms.AbstractDbObject
- - org.tentackle.persist.AbstractPersistentObject<T,P>

Type Parameters:

T - the PDO class (interface)

P - the persistence implementation class

All Implemented Interfaces:

Serializable, Cloneable, Comparable, ModificationLoggable, org.tentackle.misc.Identifiable, org.tentackle.misc.Immutable, org.tentackle.misc.Modifiable, org.tentackle.misc.SerialNumbered, org.tentackle.misc.Snapshotable<T>, DomainContextDependable, DomainContextProvider, PdoHolder<T>, PersistenceDelegate<T>, PersistentObject<T>, org.tentackle.reflect.EffectiveClassProvider<T>, org.tentackle.reflect.Interceptable, org.tentackle.session.SessionDependable, org.tentackle.session.SessionProvider, org.tentackle.validate.ScopeConfigurator, org.tentackle.validate.Validateable

Direct Known Subclasses:

NumberPoolPersistenceImpl, NumberRangePersistenceImpl, SecurityPersistenceImpl
```
public abstract class AbstractPersistentObject<T extends PersistentDomainObject<T>,P extends AbstractPersistentObject<T,P>>
extends AbstractDbObject
implements PersistentObject<T>, org.tentackle.reflect.EffectiveClassProvider<T>
```
AbstractApplication database object.
Extends AbstractDbObject with features necessary in nearly all desktop enterprise applications.
In contrast to AbstractDbObject, which is associated to a Db, an AbstractPersistentObject is associated to a DomainContext.

Author:

harald

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AN_EDITEDBY` name of the editedBy attribute.
`static String`	`AN_EDITEDEXPIRY` name of the editedExpiry attribute.
`static String`	`AN_EDITEDSINCE` name of the editedSince attribute.
`static String`	`AN_NORMTEXT` name of the normText attribute.
`static String`	`AN_ROOTCLASSID` name of rootclass-ID attribute.
`static String`	`AN_ROOTID` name of root-ID attribute.
`static String`	`CN_EDITEDBY` name of the editedBy column.
`static String`	`CN_EDITEDEXPIRY` name of the editedExpiry column.
`static String`	`CN_EDITEDSINCE` name of the editedSince column.
`static String`	`CN_NORMTEXT` name of the normText column.
`static String`	`CN_ROOTCLASSID` name of rootclass-ID column.
`static String`	`CN_ROOTID` name of root-ID column.
`protected boolean`	`objectIsSnapshot`
`static String`	`TX_DELETE_ALL_IN_CONTEXT` delete all in context
`static String`	`TX_SAVE_COPY_IN_CONTEXT` saveImpl copy in context
`static String`	`TX_TRANSFER_TOKENLOCK` transfer edited by

Fields inherited from class org.tentackle.dbms.AbstractDbObject
AN_CLASSID, AN_ID, AN_SERIAL, AN_TABLESERIAL, CN_CLASSID, CN_ID, CN_SERIAL, CN_TABLESERIAL, idComparator, nameComparator, nameIdComparator, TX_DELETE_LIST, TX_DELETE_MISSING_IN_LIST, TX_DELETE_OBJECT, TX_DUMMY_UPDATE, TX_INSERT_OBJECT, TX_INSERT_PLAIN, TX_SAVE, TX_SAVE_LIST, TX_SYNC, TX_UPDATE_OBJECT, TX_UPDATE_PLAIN, TX_UPDATE_SERIAL, TX_UPDATE_SERIAL_AND_TABLESERIAL, TX_UPDATE_TABLESERIAL

Constructor Summary

Constructors
Constructor and Description
`AbstractPersistentObject()` Creates an application database object without a database context.
`AbstractPersistentObject(T pdo)` Creates an application database object without a database context.
`AbstractPersistentObject(T pdo, DomainContext context)` Creates an application database object.
`AbstractPersistentObject(T pdo, org.tentackle.session.Session session)` Creates an application database object without a domain context for a given connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addComponents(org.tentackle.misc.IdentifiableMap<PersistentDomainObject<?>> components, boolean onlyLoaded)` Adds the components of this object to a map.
`int`	`addComponents(org.tentackle.misc.IdentifiableMap<PersistentDomainObject<?>> components, Collection<? extends PersistentDomainObject<?>> objects, boolean onlyLoaded)` Adds the components of a collection to a map.
`<R extends PersistentDomainObject<R>> boolean`	`addReferencingClass(Class<R> clazz, String methodName)` Adds a PDO class that is referencing this PDO clazz.
`protected void`	`addSnapshot(T snapshot)` Adds a snapshot to the list of snapshots.
`protected void`	`assertDomainContextMutable()` Asserts that the domain context is mutable.
`protected void`	`assertMutable()`
`protected void`	`assertNormTextProvided()` Asserts that entity provides a normtext.
`void`	`assertNotAbstract()` Asserts that this is not an abstract entity class.
`protected void`	`assertNotCached()` Asserts that the PDO is not cached.
`protected void`	`assertPersistable()`
`protected void`	`assertReadPermission()` Checks read permission for this object.
`protected void`	`assertRootContext()` Asserts that the po's context is a root context.
`void`	`assertRootContextIsAccepted()` Checks the root context agains the security rules.
`void`	`assertRootEntity()` Checks if the po is a root entity.
`protected void`	`assertTokenLockProvided()` Asserts that entity provides a normtext.
`protected void`	`assertValidSnapshot(T snapshot)` Asserts that given snapshot is valid for this object.
`protected void`	`assertWritePermission()` Checks write permission for this object.
`void`	`clearTokenLock()` Clears or renews the token lock.
`P`	`clone()`
`PersistentObject<T>`	`clonePersistentObject()`
`void`	`configureRemoteObject(DomainContext context, T obj)` Configures the remotely retrieved object.
`void`	`configureRemoteObjects(DomainContext context, Collection<T> objects)` Configures the remotely retrieved objects.
`boolean`	`containsPattern(String pattern)` Searches for a "pattern" in this object. The default implementation looks for the pattern in the normtext.
`T`	`copy()` Creates a "fast copy" of this object.
`long`	`countModification()`
`protected void`	`createAttributesInSnapshot(AbstractPersistentObject snapshot)` Updates the attributes in snapshot object. The snapshot object is assumed to be a clone of this object.
`protected void`	`createComponentsInSnapshot(AbstractPersistentObject snapshot)` Updates the components in snapshot object. The snapshot object is assumed to be a clone of this object.
`T`	`createCopyInContext(DomainContext otherContext)` Creates a new object as a copy of the current object in another (or the same) database context. The new context must be of the same class as the old one.
`String`	`createDummyUpdateSql()` Creates the SQL code for the dummy update statement. Useful get an exclusive lock within a transaction.
`protected org.tentackle.misc.PropertySupport`	`createPropertySupport()`
`StringBuilder`	`createSelectAllByIdInnerSql()`
`StringBuilder`	`createSelectAllIdSerialInnerSql()`
`StringBuilder`	`createSelectAllInnerSql()`
`String`	`createSelectAllSql()` Creates SQL code for select all. Appends context condition and order by clause if configured.
`String`	`createSelectAllWithExpiredTableSerialsSql()` Creates SQL code for `selectAllWithExpiredTableSerials(long)`. Appends context condition and order by clause if configured. By default, the result is sorted by tableserial + id.
`String`	`createSelectByNormTextSql()` Creates the SQL code for select by normtext.
`String`	`createSelectExpiredTableSerials1Sql()` Creates the SQL code for the first statement to select expired table serials.
`String`	`createSelectExpiredTableSerials2Sql()` Creates the SQL code for the second statement to select expired table serials.
`StringBuilder`	`createSelectIdInnerSql()`
`StringBuilder`	`createSelectIdInnerSql(boolean withAlias)` Creates the inner sql text to select the ID field.
`StringBuilder`	`createSelectIdInnerSql(PersistentObjectClassVariables<? super T,? super P> classVariables, boolean withAlias)` Creates the inner sql text to select the ID field.
`String`	`createSelectMaxIdSql()` Creates the SQL code for the selectMaxId statement.
`String`	`createSelectMaxTableSerialSql()` Creates the SQL code for the selectMaxTableSerial statement.
`String`	`createSelectSerialSql()` Creates the SQL code for the selectSerial statement.
`String`	`createSelectTokenLockSql()` Creates the SQL code for the select in `updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp)` statement.
`T`	`createSnapshot()` Creates a snapshot of this object.
`String`	`createTransferTokenLockSql()` Creates the SQL code for the `transferTokenLock(long)` statement without tableserial.
`String`	`createTransferTokenLockWithTableSerialSql()` Creates the SQL code for the `transferTokenLock(long)` statement with tableserial.
`String`	`createUpdateSerialAndTableSerialSql()` Creates the SQL code for the serial + tableSerial update statement.
`String`	`createUpdateSerialSql()` Creates the SQL code for the serial update statement.
`String`	`createUpdateTokenLockOnlySql()` Creates the SQL code for the `updateTokenLockOnly()` statement.
`String`	`createUpdateTokenLockSql()` Creates the SQL code for the `updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp)` statement.
`String`	`createUpdateTokenLockWithCountSql()` Creates the SQL code for the `updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp)` statement with mod counting.
`DomainContext`	`createValidContext()`
`void`	`delete()`
`protected <X extends PersistentDomainObject<X>> void`	`delete(Collection<X> pdos)` Deletes a List of objects. This method is provided to mark components in PDOs only.
`protected void`	`delete(PersistentDomainObject<?> pdo)` Deletes a PDO. This method is provided to save components in PDOs only.
`protected void`	`deleteImpl()` Implementation of delete bypassing the invocation handler.
`protected <X extends PersistentDomainObject<X>> void`	`deleteMissingInCollection(Collection<X> oldCollection, Collection<X> newCollection)` Deletes all objects in oldList that are not in newList. This method is provided to save components in PDOs only.
`void`	`deletePlainWithComponents()` Deletes this object and all its components without any further processing. Same as `AbstractDbObject.deletePlain()` but with components.
`int`	`deletePlainWithComponents(Collection<? extends PersistentDomainObject<?>> objects)` Deletes plain with components all objects of a collection.
`T`	`derivePdoFromPo(T pdo, P po)` Derive the concrete PDO from a given PO.
`void`	`determineContextId()`
`T`	`executeFirstPdoQuery(PreparedStatementWrapper st)` Executes a query for a prepared statement and returns the first PDO.
`T`	`executeFirstPdoQuery(PreparedStatementWrapper st, JoinedSelect<T> js)` Executes a query for a prepared statement and returns the first PDO.
`List<T>`	`executeListQuery(PreparedStatementWrapper st)` Executes the query for a prepared statement and returns the results in a list.
`List<T>`	`executeListQuery(PreparedStatementWrapper st, JoinedSelect<T> js)` Executes the query for a prepared statement and returns the results in a list.
`void`	`executeQueryToList(PreparedStatementWrapper st, JoinedSelect<T> js, List<T> list)` Executes the query for a prepared statement and adds the results to a list.
`void`	`executeQueryToList(ResultSetWrapper rs, JoinedSelect<T> js, List<T> list)` Executes the query for a prepared statement and adds the results to a list.
`org.tentackle.misc.TrackedList<T>`	`executeTrackedListQuery(PreparedStatementWrapper st)` Executes the query for a prepared statement and returns the results in a tracked list.
`org.tentackle.misc.TrackedList<T>`	`executeTrackedListQuery(PreparedStatementWrapper st, JoinedSelect<T> js)` Executes the query for a prepared statement and returns the results in a tracked list.
`boolean`	`expireCache(long maxSerial)` Expires the cache according to the serial numbers. If objects of this class are cached, the cache must be expired on updates, etc...
`T`	`findDuplicate()` Checks whether this object (if saved) would violate any unique constraints.
`protected Method`	`findSnapshotMethod(String methodName, Class<?> clazz)` Finds a snapshot method. Snapshot methods (`createAttributesInSnapshot(org.tentackle.persist.AbstractPersistentObject)`, `createComponentsInSnapshot(org.tentackle.persist.AbstractPersistentObject)`, `revertAttributesToSnapshot(org.tentackle.persist.AbstractPersistentObject)` and `revertComponentsToSnapshot(org.tentackle.persist.AbstractPersistentObject)`) take the snapshot object with the correct implementation type and are implemented at some implementation class.
`void`	`finishModification(char modType)`
`void`	`finishNotUpdated(char modType)`
`DomainContext`	`getBaseContext()`
`PdoCache<T>`	`getCache()` Gets the cache.
`long`	`getCacheAccessCount()` Gets the cache access count.
`long`	`getCacheAccessTime()` Gets the last cache access time.
`PersistentObjectClassVariables<T,P>`	`getClassVariables()` Gets the application oriented class variables for this object. Class variables for classes derived from AbstractPersistentObject are kept in an instance of `PersistentObjectClassVariables`.
`String`	`getColumnName(String name)` Gets the full column name with optional table alias.
`long`	`getContextId()`
`long`	`getContextUserId()` Gets the user id from the current context, i.e.
`T`	`getCopiedObject()` Gets the original object if this object was created by `createCopyInContext(org.tentackle.pdo.DomainContext)`.
`Class<? extends org.tentackle.validate.ValidationScope>[]`	`getDefaultScopes()`
`DomainContext`	`getDomainContext()`
`DomainDelegate<T>`	`getDomainDelegate()`
`JoinedSelect<T>`	`getEagerJoinedSelect()` Adds the eager joins to the created SQL.
`List<Join<? super T,?>>`	`getEagerJoins()` Returns the eager joins for this PDO.
`long`	`getEditedBy()` Gets the id of the user currently editing this object.
`org.tentackle.common.Timestamp`	`getEditedExpiry()` Gets the time since when this object is being edited.
`org.tentackle.common.Timestamp`	`getEditedSince()` Gets the time since when this object is being edited.
`Class<T>`	`getEffectiveClass()`
`List<Class<? super T>>`	`getEffectiveSuperClasses()`
`String`	`getNormText()` Gets the normtext.
`T`	`getPdo()`
`Class<T>`	`getPdoClass()` Gets the pdo-class.
`<R extends PersistentDomainObject<R>> Class<? extends AbstractPersistentObject<?,?>>`	`getPersistenceClass(Class<R> clazz)` Gets the persistence class from a pdo class.
`org.tentackle.persist.rmi.AbstractPersistentObjectRemoteDelegate<T,P>`	`getRemoteDelegate()`
`int`	`getRootClassId()`
`long`	`getRootId()`
`SecurityResult`	`getSecurityResult(Permission permission)`
`List<T>`	`getSnapshots()` Gets all snapshots.
`String`	`getSqlClassIdCondition()` Gets the additional condition to be used in the WHERE clause for the classid.
`String`	`getSqlContextCondition()` Gets the SQL code for the context condition.
`String`	`getTableAlias()` Gets the table alias.
`String`	`getTableName()`
`<U extends PersistentDomainObject<U>> U`	`getTokenLockObject()` Gets the object associated to the id of the editedBy-attribute. This is usually the id of a persistent Object implementing the concept of a user, group, role or whatever.
`long`	`getTokenLockTimeout()` Gets the expiration in milliseconds of the "being-edited-token" if this object should request such a token when being edited.
`String`	`getTopSuperTableAlias()` Gets the alias for the topmost super class.
`String`	`getTopSuperTableName()` Gets the tablename for the topmost super class.
`Object`	`getTransientData()` Gets the optional transient data object. The default implementation does nothing.
`int`	`getValidClassId()` Gets the classid.
`void`	`initModification(char modType)`
`void`	`insertObject()`
`void`	`insertPlainWithComponents()` Inserts this object and all its components without any further processing. Same as `AbstractDbObject.insertPlain()` but with components.
`int`	`insertPlainWithComponents(Collection<? extends PersistentDomainObject<?>> objects)` Inserts plain with components all objects of a collection.
`boolean`	`isAbstract()` Returns whether this an abstract PDO. Abstract PDOs are real objects but cannot be persisted.
`boolean`	`isCacheable()` Determines whether object is cacheable or not.
`boolean`	`isCached()`
`boolean`	`isClassIdRequiredInWhereClause()` Returns whether the classid needs to be inluded in the WHERE-clause. Applies only to leafs with SINGLE inheritance.
`boolean`	`isComposite()` Tells whether this object is composite (i.e.
`boolean`	`isCountingModificationForTokenLock()`
`boolean`	`isDomainContextImmutable()` Returns whether the domain context is immutable.
`boolean`	`isEditAllowed()`
`boolean`	`isExpired()` Checks whether object has been marked expired.
`boolean`	`isExplicitIdAliasRequiredInJoins()` Returns whether an explicit id alias is necessary in joins. This applies to MULTI-table inherited PDOs only (abstracts and leafs).
`protected <X extends PersistentDomainObject<X>> boolean`	`isModified(Collection<X> pdos)` Checks whether some of the objects in the list are modified. This method is provided to save components in PDOs only.
`boolean`	`isNormTextProvided()`
`boolean`	`isPermissionAccepted(Permission permission)`
`boolean`	`isPersistable()`
`boolean`	`isReadAllowed()` Determines whether the application is allowed to read this PDO. Makes no sense to publish in PersistentObject because PDOs without read permissions are not read from the database at all.
`boolean`	`isReferenced()`
`boolean`	`isRenewTokenLockRequested()` Determines whether to renew the token lock on saveImpl or update.
`boolean`	`isRootClassIdProvided()`
`boolean`	`isRootEntity()`
`<C extends PersistentDomainObject<C>> boolean`	`isRootEntityOf(C component)`
`boolean`	`isRootIdProvided()`
`boolean`	`isSnapshot()` Returns whether this is a snapshot.
`boolean`	`isTokenLocked()` Checks whether this object is token locked (editedBy != 0) and the lock is not expired.
`boolean`	`isTokenLockedBy(long userId)` Checks whether this object is edited locked by given user.
`boolean`	`isTokenLockedByMe()` Checks whether this object is edited locked by the current user.
`boolean`	`isTokenLockProvided()` By default objects don't need to include the editedBy/Since/Expiry columns in the database table.
`protected boolean`	`isUpdateNecessary()`
`boolean`	`isUpdatingSerialEvenIfNotModified()` Determines whether in updates of composite objects unmodified objects in the update path get at least the serial updated or are not touched at all.
`boolean`	`isValidated()`
`boolean`	`isViewAllowed()`
`boolean`	`isWriteAllowed()`
`org.tentackle.misc.IdentifiableMap<? extends PersistentDomainObject<?>>`	`loadComponents(boolean onlyLoaded)` Loads all components. The method is used to transfer a copy of an object between tiers including all composite object relations recursively.
`void`	`markCacheAccess()` mark cache access (count and set current system-time)
`protected <X extends PersistentDomainObject<X>> void`	`markDeleted(Collection<X> pdos)` Marks all objects in a list to be deleted. This method is provided to mark components in PDOs only.
`protected void`	`markDeleted(PersistentDomainObject<?> pdo)` Marks an object to be deleted. This method is provided to mark components in PDOs only.
`void`	`newId()`
`String`	`orderBy()` Gets the natural ordering to be added in WHERE-clauses following "ORDER BY ".
`T`	`pdo()`
`T`	`persist()`
`protected T`	`persistImpl()` Implementation of persist bypassing the invocation handler.
`T`	`persistTokenLocked()`
`P`	`readFromResultSetWrapper(ResultSetWrapper rs)`
`void`	`readJoinedRow(ResultSetWrapper rs, JoinedSelect<T> js)` Reads the next row from a result set within a joined select. The results may come in any order.
`void`	`releaseTokenLock()` Releases an edited by lock. Use this method if a PDO needs to be unlocked without being persisted.
`T`	`reload()` Reloads the object.
`T`	`reloadLocked()` Reloads the object with a write lock.
`<R extends PersistentDomainObject<R>> boolean`	`removeReferencingClass(Class<R> clazz, String methodName)` Removes a PDO class that is referencing this PDO clazz.
`void`	`requestTokenLock()` Requests an edited by lock.
`ResultSetWrapper`	`resultAll(JoinedSelect<T> js)` Gets the result set for all objects in the current context for use in lists.
`ResultSetWrapper`	`resultAllCursor(JoinedSelect<T> js)` Gets the result set for all objects in the current context for use in cursors. Cursors differ from lists because they need `ResultSet.TYPE_SCROLL_INSENSITIVE` set.
`ResultSetWrapper`	`resultAllWithExpiredTableSerials(JoinedSelect<T> js, long oldSerial)` Gets the result set for all objects in the current context with a given expired tableserial.
`ResultSetWrapper`	`resultByNormText(String normText, JoinedSelect<T> js)` Gets the result set for the normtext query (where normtext like ?) for use in lists. If the given normtext is null or just "%" the method falls back to `resultAll(org.tentackle.persist.JoinedSelect<T>)`.
`ResultSetWrapper`	`resultByNormTextCursor(String normText, JoinedSelect<T> js)` Gets the result set for the normtext query (where normtext like ?) for use in cursors. Cursors differ from lists because they need `ResultSet.TYPE_SCROLL_INSENSITIVE` set.
`protected void`	`revertAttributesToSnapshot(AbstractPersistentObject snapshot)` Copies all attributes from a snapshot object back to this object.
`protected void`	`revertComponentsToSnapshot(AbstractPersistentObject snapshot)` Reverts all components of this object to a given snapshot.
`void`	`revertToSnapshot(T snapshot)` Reverts the state of this object to given snapshot.
`void`	`save()`
`protected <X extends PersistentDomainObject<X>> void`	`save(Collection<X> pdos, boolean modifiedOnly)` Saves a list of PDOs. This method is provided to save components in PDOs only.
`protected void`	`save(PersistentDomainObject<?> pdo)` Saves a PDO. This method is provided to save components in PDOs only.
`T`	`saveCopyInContext(DomainContext otherContext)` Same as `createCopyInContext(org.tentackle.pdo.DomainContext)` but saves the new object within a transaction.
`protected void`	`saveImpl()` Implementation of save bypassing the invocation handler.
`T`	`select(long id)` Loads a PDO from the database by its unique ID.
`T`	`select(long id, boolean locked)` Loads a PDO from the database by its unique ID.
`List<T>`	`selectAll()` Selects all records in current context as a list.
`org.tentackle.misc.ScrollableResource<T>`	`selectAllAsCursor()` Selects all records in current context as a cursor
`List<T>`	`selectAllCached()` Gets all objects in context via cache.
`List<T>`	`selectAllForCache()`
`List<T>`	`selectAllWithExpiredTableSerials(long oldSerial)`
`List<T>`	`selectByNormText(String normText)` Selects all objects with a given normtext as a list.
`org.tentackle.misc.ScrollableResource<T>`	`selectByNormTextAsCursor(String normText)` Selects all objects with a given normtext as a cursor.
`T`	`selectByTemplate(AbstractPersistentObject<T,P> template)` Selects an object according to a template object.
`T`	`selectCached(long id)` Gets the object via cache. If there is no cache (i.e.
`T`	`selectCachedOnly(long id)` Gets the object via cache only. If there is no cache (i.e.
`T`	`selectForCache(long id)`
`T`	`selectLocked(long id)` Loads and write-locks a PDO from the database by its unique ID.
`protected int`	`setClassIdsInStatement(JoinedSelect<T> js, PreparedStatementWrapper st, int ndx)` Sets the class-ID parameters if required for the joins. Notice that this method only works for joins with no subjoins and is used only for eager joins, i.e.
`void`	`setDomainContext(DomainContext context)`
`void`	`setDomainContextImmutable(boolean contextImmutable)` Sets the immutable flag of the domain context.
`void`	`setEditedBy(long editedBy)` Sets the user editing this object. Does NOT alter isModified() and does not require the object to be mutable.
`void`	`setEditedExpiry(org.tentackle.common.Timestamp editedExpiry)` Sets the time when the token should expire. Does NOT alter isModified() and does not require the object to be mutable.
`void`	`setEditedSince(org.tentackle.common.Timestamp editedSince)` Sets the time since when this object is being edited. Does NOT alter isModified() and does not require the object to be mutable.
`void`	`setExpired(boolean expired)` Sets this object's expiration flag.
`void`	`setModified(boolean modified)`
`void`	`setNormText(String normText)` Sets the normtext.
`void`	`setPdo(T pdo)`
`void`	`setPersistable(boolean persistable)` Sets the local persistable flag.
`void`	`setRenewTokenLockRequested(boolean renewTokenLock)` Sets whether to apply or renew the token lock on insert or update.
`void`	`setRootClassId(int rootClassId)`
`void`	`setRootId(long rootId)`
`<U extends PersistentDomainObject<U>> void`	`setTokenLockObject(U obj)` Sets the user/group/role-object editing this object.
`void`	`setTransientData(Object data)` Sets the optional transient data object. Sometimes, e.g.
`T`	`transferTokenLock(long userId)`
`void`	`updateObject()`
`boolean`	`updateRootContext()` Updates the root context. Method is used after deserialization.
`void`	`updateTokenLock(org.tentackle.common.Timestamp tokenExpiry)` Updates editing info in db-record (if feature enabled). Will NOT log modification and NOT update the serial-counter! Must be called from within application where appropriate.
`void`	`updateTokenLock(org.tentackle.common.Timestamp tokenExpiry, long userId, org.tentackle.common.Timestamp curTime)` Updates token lock columns in db-record. Will NOT log modification and NOT update the serial-counter! Must be called from within application where appropriate.
`void`	`updateTokenLockOnly()` Update the editedBy-attributes to persistent storage. No check is done whether locked or not and there is no serial update and no modlog.
`void`	`validate()`
`List<org.tentackle.validate.ValidationResult>`	`validate(String validationPath, org.tentackle.validate.ValidationScope scope)`

Methods inherited from class org.tentackle.dbms.AbstractDbObject
acceptPersistenceVisitor, addPropertyChangeListener, addPropertyListener, assertNotNew, assertNotOverloaded, assertNotRemote, assertNumberOfRowsAffected, assertRemote, assertThisRowAffected, attributesModified, beginTx, clearOnRemoteSave, compareTo, copyToDb, createAttributesInSnapshot, createDeleteAllSql, createDeleteSql, createInsertSql, createPreparedStatement, createPreparedStatement, createSelectObjectsWithExpiredTableSerialsSql, createSelectSql, createSqlUpdate, createUpdateAndSetSerialSql, createUpdateSql, deleteImpl, deleteObject, deletePlain, deleteReferencedRelations, deleteReferencingRelations, differsPersisted, dummyUpdate, equals, firePropertyChange, getBackend, getClassBaseName, getClassId, getColumnCount, getExpirationBacklog, getExpiredTableSerials, getFields, getId, getIdSource, getImmutableLoggingLevel, getModificationCount, getModificationLog, getPreparedStatement, getPreparedStatement, getSerial, getSession, getSessionHolder, getTableSerial, hashCode, insertImpl, insertPlain, isCountingModification, isDeleted, isEntity, isFromThisJVM, isIdValid, isImmutable, isLoggingModification, isModified, isNew, isOverloadable, isRemovable, isSessionImmutable, isStatementAlwaysPrepared, isTableSerialProvided, isTracked, isVirgin, loadLazyReferences, logModification, markDeleted, newInstance, newInstance, newInstance, persistObject, prepareDelete, prepareSave, prepareSetFields, reloadLockedObject, reloadObject, removeAllPropertyChangeListeners, removePropertyChangeListener, removePropertyListener, reserveId, resultAllIdSerial, resultAllObjects, resultObjectsWithExpiredTableSerials, revertAttributesToSnapshot, saveObject, saveReferencedRelations, saveReferencingRelations, selectAllIdSerial, selectAllObjects, selectExpiredTableSerials, selectExpiredTableSerials, selectLockedObject, selectMaxId, selectMaxTableSerial, selectNextObject, selectObject, selectObjectsWithExpiredTableSerials, selectSerial, setClassId, setFields, setId, setImmutable, setImmutableLoggingLevel, setModificationLog, setOverloadable, setSerial, setSession, setSessionHolder, setSessionImmutable, setStatementAlwaysPrepared, setTableSerial, toGenericString, toIdString, toString, unmarkDeleted, updateImpl, updatePlain, updateSerial, updateSerial, updateSerialAndTableSerial

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tentackle.pdo.PersistentObject
attributesModified, differsPersisted, getClassBaseName, getClassId, getExpiredTableSerials, getId, getModificationCount, getSerial, getTableSerial, isDeleted, isImmutable, isNew, isRemovable, isTableSerialProvided, isTracked, prepareDelete, reserveId, selectAllIdSerial, selectExpiredTableSerials, selectExpiredTableSerials, selectMaxId, selectMaxTableSerial, selectSerial, setId, setImmutable, setSerial, setTableSerial, toIdString

Methods inherited from interface org.tentackle.pdo.PdoHolder
on

Methods inherited from interface org.tentackle.misc.Identifiable
toGenericString

Methods inherited from interface org.tentackle.misc.Modifiable
isModified

Methods inherited from interface org.tentackle.misc.SerialNumbered
isVirgin

Methods inherited from interface org.tentackle.pdo.DomainContextProvider
on, op

Methods inherited from interface org.tentackle.session.SessionDependable
isSessionImmutable, setSession, setSessionImmutable

Methods inherited from interface org.tentackle.session.SessionProvider
getSession

Methods inherited from interface org.tentackle.reflect.EffectiveClassProvider
getEffectiveClass

Methods inherited from interface org.tentackle.dbms.ModificationLoggable
createModificationLog

- Field Detail
 - objectIsSnapshot
```
protected transient boolean objectIsSnapshot
```
 - CN_EDITEDBY
```
public static final String CN_EDITEDBY
```
 name of the editedBy column.
 
 See Also:
 
 Constant Field Values
 - AN_EDITEDBY
```
public static final String AN_EDITEDBY
```
 name of the editedBy attribute.
 
 See Also:
 
 Constant Field Values
 - CN_EDITEDEXPIRY
```
public static final String CN_EDITEDEXPIRY
```
 name of the editedExpiry column.
 
 See Also:
 
 Constant Field Values
 - AN_EDITEDEXPIRY
```
public static final String AN_EDITEDEXPIRY
```
 name of the editedExpiry attribute.
 
 See Also:
 
 Constant Field Values
 - CN_EDITEDSINCE
```
public static final String CN_EDITEDSINCE
```
 name of the editedSince column.
 
 See Also:
 
 Constant Field Values
 - AN_EDITEDSINCE
```
public static final String AN_EDITEDSINCE
```
 name of the editedSince attribute.
 
 See Also:
 
 Constant Field Values
 - CN_NORMTEXT
```
public static final String CN_NORMTEXT
```
 name of the normText column.
 
 See Also:
 
 Constant Field Values
 - AN_NORMTEXT
```
public static final String AN_NORMTEXT
```
 name of the normText attribute.
 
 See Also:
 
 Constant Field Values
 - CN_ROOTID
```
public static final String CN_ROOTID
```
 name of root-ID column.
 
 See Also:
 
 Constant Field Values
 - AN_ROOTID
```
public static final String AN_ROOTID
```
 name of root-ID attribute.
 
 See Also:
 
 Constant Field Values
 - CN_ROOTCLASSID
```
public static final String CN_ROOTCLASSID
```
 name of rootclass-ID column.
 
 See Also:
 
 Constant Field Values
 - AN_ROOTCLASSID
```
public static final String AN_ROOTCLASSID
```
 name of rootclass-ID attribute.
 
 See Also:
 
 Constant Field Values
 - TX_SAVE_COPY_IN_CONTEXT
```
public static final String TX_SAVE_COPY_IN_CONTEXT
```
 saveImpl copy in context
 
 See Also:
 
 Constant Field Values
 - TX_DELETE_ALL_IN_CONTEXT
```
public static final String TX_DELETE_ALL_IN_CONTEXT
```
 delete all in context
 
 See Also:
 
 Constant Field Values
 - TX_TRANSFER_TOKENLOCK
```
public static final String TX_TRANSFER_TOKENLOCK
```
 transfer edited by
 
 See Also:
 
 Constant Field Values
- Constructor Detail
 - AbstractPersistentObject
```
public AbstractPersistentObject(T pdo,
 DomainContext context)
```
 Creates an application database object.
 
 Parameters:
 
 pdo - the persistent domain object this is a delegate for
 
 context - the database context
 - AbstractPersistentObject
```
public AbstractPersistentObject(T pdo,
 org.tentackle.session.Session session)
```
 Creates an application database object without a domain context for a given connection.
 Note: the application must set the context.
 
 Parameters:
 
 pdo - the persistent domain object this is a delegate for
 
 session - the session (must be an instance of Session).
 - AbstractPersistentObject
```
public AbstractPersistentObject(T pdo)
```
 Creates an application database object without a database context.
 Note: the application must set the context.
 
 Parameters:
 
 pdo - the persistent domain object this is a delegate for
 - AbstractPersistentObject
```
public AbstractPersistentObject()
```
 Creates an application database object without a database context.
- Method Detail
 - getDomainDelegate
```
public DomainDelegate<T> getDomainDelegate()
```
 Specified by:
 
 getDomainDelegate in interface PersistenceDelegate<T extends PersistentDomainObject<T>>
 - getPdo
```
public T getPdo()
```
 Specified by:
 
 getPdo in interface PdoHolder<T extends PersistentDomainObject<T>>
 - pdo
```
public T pdo()
```
 Specified by:
 
 pdo in interface PersistentObject<T extends PersistentDomainObject<T>>
 - setPdo
```
public void setPdo(T pdo)
```
 Specified by:
 
 setPdo in interface PdoHolder<T extends PersistentDomainObject<T>>
 - getEffectiveClass
```
public Class<T> getEffectiveClass()
```
 Specified by:
 
 getEffectiveClass in interface org.tentackle.reflect.EffectiveClassProvider<T extends PersistentDomainObject<T>>
 - getEffectiveSuperClasses
```
public List<Class<? super T>> getEffectiveSuperClasses()
```
 Specified by:
 
 getEffectiveSuperClasses in interface org.tentackle.reflect.EffectiveClassProvider<T extends PersistentDomainObject<T>>
 - clone
```
public P clone()
```
 Overrides:
 
 clone in class AbstractDbObject>
 - clonePersistentObject
```
public PersistentObject<T> clonePersistentObject()
```
 Specified by:
 
 clonePersistentObject in interface PersistentObject<T extends PersistentDomainObject<T>>
 - findSnapshotMethod
```
protected Method findSnapshotMethod(String methodName,
 Class<?> clazz)
 throws NoSuchMethodException
```
 Finds a snapshot method.
 Snapshot methods (createAttributesInSnapshot(org.tentackle.persist.AbstractPersistentObject), createComponentsInSnapshot(org.tentackle.persist.AbstractPersistentObject), revertAttributesToSnapshot(org.tentackle.persist.AbstractPersistentObject) and revertComponentsToSnapshot(org.tentackle.persist.AbstractPersistentObject)) take the snapshot object with the correct implementation type and are implemented at some implementation class. This method finds the most specific snapshot-method along the inheritance hierarchy.
 
 Parameters:
 
 methodName - the snapshot method name
 
 clazz - the implementation class
 
 Returns:
 
 the method
 
 Throws:
 
 NoSuchMethodException - if no such method found
 - createSnapshot
```
public T createSnapshot()
```
 Creates a snapshot of this object.
 The method must be implemented. The default implementation just throws PersistenceException.
 
 Specified by:
 
 createSnapshot in interface org.tentackle.misc.Snapshotable<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the snapshot
 - createAttributesInSnapshot
```
protected void createAttributesInSnapshot(AbstractPersistentObject snapshot)
```
 Updates the attributes in snapshot object.
 The snapshot object is assumed to be a clone of this object.
 
 Parameters:
 
 snapshot - the snapshot
 - createComponentsInSnapshot
```
protected void createComponentsInSnapshot(AbstractPersistentObject snapshot)
```
 Updates the components in snapshot object.
 The snapshot object is assumed to be a clone of this object.
 
 Parameters:
 
 snapshot - the snapshot
 - revertToSnapshot
```
public void revertToSnapshot(T snapshot)
```
 Reverts the state of this object to given snapshot.
 The method must be implemented. The default implementation just throws PersistenceException.
 
 Specified by:
 
 revertToSnapshot in interface org.tentackle.misc.Snapshotable<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 snapshot - the snapshot to revert to
 - revertAttributesToSnapshot
```
protected void revertAttributesToSnapshot(AbstractPersistentObject snapshot)
```
 Copies all attributes from a snapshot object back to this object.
 
 Parameters:
 
 snapshot - the snapshot object
 - revertComponentsToSnapshot
```
protected void revertComponentsToSnapshot(AbstractPersistentObject snapshot)
```
 Reverts all components of this object to a given snapshot.
 
 Parameters:
 
 snapshot - the snapshot object
 - isSnapshot
```
public boolean isSnapshot()
```
 Returns whether this is a snapshot.
 
 Specified by:
 
 isSnapshot in interface org.tentackle.misc.Snapshotable<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if this is a snapshot
 - getSnapshots
```
public List<T> getSnapshots()
```
 Gets all snapshots.
 
 Specified by:
 
 getSnapshots in interface org.tentackle.misc.Snapshotable<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the list of snapshots for this object, null if none taken so far
 - addSnapshot
```
protected void addSnapshot(T snapshot)
```
 Adds a snapshot to the list of snapshots.
 
 Parameters:
 
 snapshot - the snapshot to add
 - assertValidSnapshot
```
protected void assertValidSnapshot(T snapshot)
```
 Asserts that given snapshot is valid for this object.
 
 Parameters:
 
 snapshot - the snapshot
 - assertNotCached
```
protected void assertNotCached()
```
 Asserts that the PDO is not cached.
 - assertMutable
```
protected void assertMutable()
```
 Overridden due to snapshots are immutable.
 
 Overrides:
 
 assertMutable in class AbstractDbObject>
 - isPersistable
```
public boolean isPersistable()
```
 Specified by:
 
 isPersistable in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Overrides:
 
 isPersistable in class AbstractDbObject>
 - setPersistable
```
public void setPersistable(boolean persistable)
```
 Sets the local persistable flag.
 The implementation maintains an additional flag to disable persistabilty.
 
 Parameters:
 
 persistable - true if persistable, false if not persistable
 - assertPersistable
```
protected void assertPersistable()
```
 Overridden to provide detailed exception message.
 
 Overrides:
 
 assertPersistable in class AbstractDbObject>
 - createPropertySupport
```
protected org.tentackle.misc.PropertySupport createPropertySupport()
```
 Overrides:
 
 createPropertySupport in class AbstractDbObject>
 - isRootEntity
```
public boolean isRootEntity()
```
 The default is false. Override if this is a root-entity.
 
 Specified by:
 
 isRootEntity in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isRootIdProvided
```
public boolean isRootIdProvided()
```
 Specified by:
 
 isRootIdProvided in interface PersistentObject<T extends PersistentDomainObject<T>>
 - getRootId
```
public long getRootId()
```
 Specified by:
 
 getRootId in interface PersistentObject<T extends PersistentDomainObject<T>>
 - setRootId
```
public void setRootId(long rootId)
```
 Specified by:
 
 setRootId in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isRootClassIdProvided
```
public boolean isRootClassIdProvided()
```
 Specified by:
 
 isRootClassIdProvided in interface PersistentObject<T extends PersistentDomainObject<T>>
 - getRootClassId
```
public int getRootClassId()
```
 Specified by:
 
 getRootClassId in interface PersistentObject<T extends PersistentDomainObject<T>>
 - setRootClassId
```
public void setRootClassId(int rootClassId)
```
 Specified by:
 
 setRootClassId in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isRootEntityOf
```
public <C extends PersistentDomainObject<C>> boolean isRootEntityOf(C component)
```
 Specified by:
 
 isRootEntityOf in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isNormTextProvided
```
public boolean isNormTextProvided()
```
 Specified by:
 
 isNormTextProvided in interface PersistentObject<T extends PersistentDomainObject<T>>
 - assertNormTextProvided
```
protected void assertNormTextProvided()
```
 Asserts that entity provides a normtext.
 - setNormText
```
public void setNormText(String normText)
```
 Sets the normtext.
 
 Specified by:
 
 setNormText in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 normText - the normtext
 - getNormText
```
public String getNormText()
```
 Gets the normtext.
 
 Specified by:
 
 getNormText in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the normtext
 - isDomainContextImmutable
```
public boolean isDomainContextImmutable()
```
 Returns whether the domain context is immutable.
 
 Specified by:
 
 isDomainContextImmutable in interface DomainContextDependable
 
 Returns:
 
 true if context cannot be changed
 - setDomainContextImmutable
```
public void setDomainContextImmutable(boolean contextImmutable)
```
 Sets the immutable flag of the domain context.
 
 Specified by:
 
 setDomainContextImmutable in interface DomainContextDependable
 
 Parameters:
 
 contextImmutable - true if context cannot be changed
 - assertDomainContextMutable
```
protected void assertDomainContextMutable()
```
 Asserts that the domain context is mutable.
 - setDomainContext
```
public void setDomainContext(DomainContext context)
```
 Setting the context will also set the session and context id.
 
 Specified by:
 
 setDomainContext in interface DomainContextDependable
 - getDomainContext
```
public DomainContext getDomainContext()
```
 The default implementation just returns the context. Subclasses may override this with a covariant method.
 
 Specified by:
 
 getDomainContext in interface DomainContextProvider
 - determineContextId
```
public void determineContextId()
```
 The default implementation does nothing (object living in a context not depending on another object).
 
 Specified by:
 
 determineContextId in interface DomainContextDependable
 - getContextId
```
public long getContextId()
```
 The default implementation returns -1.
 
 Specified by:
 
 getContextId in interface DomainContextDependable
 - getSqlContextCondition
```
public String getSqlContextCondition()
```
 Gets the SQL code for the context condition.
 
 Returns:
 
 null if no condition (default)
 - getSqlClassIdCondition
```
public String getSqlClassIdCondition()
```
 Gets the additional condition to be used in the WHERE clause for the classid.
```
 Example: return " AND " + CN_CLASSID + "=?";
 
```
 Returns:
 
 the condition, null if none necessary
 - getBaseContext
```
public DomainContext getBaseContext()
```
 The default implementation returns the PDO's DomainContext.
 
 Specified by:
 
 getBaseContext in interface DomainContextDependable
 - createValidContext
```
public DomainContext createValidContext()
```
 The default implementation just returns a new DomainContext.
 
 Specified by:
 
 createValidContext in interface DomainContextDependable
 - getClassVariables
```
public PersistentObjectClassVariables<T,P> getClassVariables()
```
 Gets the application oriented class variables for this object.
 Class variables for classes derived from AbstractPersistentObject are kept in an instance of PersistentObjectClassVariables.
 
 Overrides:
 
 getClassVariables in class AbstractDbObject>
 
 Returns:
 
 the class variables
 
 See Also:
 
 AbstractDbObject.getClassVariables()
 - getTableName
```
public String getTableName()
```
 Specified by:
 
 getTableName in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Overrides:
 
 getTableName in class AbstractDbObject>
 - getTableAlias
```
public String getTableAlias()
```
 Gets the table alias.
 
 Returns:
 
 the alias, null if class does not map to a database table
 - getColumnName
```
public String getColumnName(String name)
```
 Gets the full column name with optional table alias.
 
 Parameters:
 
 name - the short name
 
 Returns:
 
 the full name
 - getTopSuperTableAlias
```
public String getTopSuperTableAlias()
```
 Gets the alias for the topmost super class.
 
 Returns:
 
 the alias
 - getTopSuperTableName
```
public String getTopSuperTableName()
```
 Gets the tablename for the topmost super class.
 
 Returns:
 
 the alias
 - getPdoClass
```
public Class<T> getPdoClass()
```
 Gets the pdo-class.
 
 Returns:
 
 the class of the associated PDO
 - isAbstract
```
public boolean isAbstract()
```
 Returns whether this an abstract PDO.
 Abstract PDOs are real objects but cannot be persisted. They may be used to retrieve data for the concrete implementations, however.
 
 Specified by:
 
 isAbstract in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if abstract PDO
 - assertNotAbstract
```
public void assertNotAbstract()
```
 Asserts that this is not an abstract entity class.
 - getValidClassId
```
public int getValidClassId()
```
 Gets the classid.
 
 Returns:
 
 the classid
 
 Throws:
 
 org.tentackle.session.PersistenceException - if not valid
 - isClassIdRequiredInWhereClause
```
public boolean isClassIdRequiredInWhereClause()
```
 Returns whether the classid needs to be inluded in the WHERE-clause.
 Applies only to leafs with SINGLE inheritance.
 
 Returns:
 
 true if include classid
 - isExplicitIdAliasRequiredInJoins
```
public boolean isExplicitIdAliasRequiredInJoins()
```
 Returns whether an explicit id alias is necessary in joins.
 This applies to MULTI-table inherited PDOs only (abstracts and leafs).
 
 Returns:
 
 true if need explicit id alias
 - isComposite
```
public boolean isComposite()
```
 Tells whether this object is composite (i.e. has composite relations).
 The method is overridden by the PdoRelations-wurblet if at least one relation is flagged as "composite". The default implementation returns false.
 
 Specified by:
 
 isComposite in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if object is composite, false if not.
 - loadComponents
```
public org.tentackle.misc.IdentifiableMap<? extends PersistentDomainObject<?>> loadComponents(boolean onlyLoaded)
```
 Loads all components.
 The method is used to transfer a copy of an object between tiers including all composite object relations recursively. Furthermore, it can be used to get a map of all components. By default the method throws a PersistenceException telling that it is not implemented if isComposite() returns true.
 
 Parameters:
 
 onlyLoaded - true if return only already loaded components (lazy composite relations)
 
 Returns:
 
 the map of all components, including this object.
 - addComponents
```
public int addComponents(org.tentackle.misc.IdentifiableMap<PersistentDomainObject<?>> components,
 boolean onlyLoaded)
```
 Adds the components of this object to a map.
 
 Parameters:
 
 components - the component map
 
 onlyLoaded - true if return only already loaded component (lazy composite relations)
 
 Returns:
 
 the number of components added
 - addComponents
```
public int addComponents(org.tentackle.misc.IdentifiableMap<PersistentDomainObject<?>> components,
 Collection<? extends PersistentDomainObject<?>> objects,
 boolean onlyLoaded)
```
 Adds the components of a collection to a map.
 
 Parameters:
 
 components - the components map
 
 objects - the collection of objects to add along with their components
 
 onlyLoaded - true if return only already loaded components (lazy composite relations)
 
 Returns:
 
 the number of components added
 - deletePlainWithComponents
```
public void deletePlainWithComponents()
```
 Deletes this object and all its components without any further processing.
 Same as AbstractDbObject.deletePlain() but with components.
 - deletePlainWithComponents
```
public int deletePlainWithComponents(Collection<? extends PersistentDomainObject<?>> objects)
```
 Deletes plain with components all objects of a collection.
 
 Parameters:
 
 objects - the collection of PDOs
 
 Returns:
 
 the number of objects processed, < 0 if failed (number*(-1)-1)
 - insertPlainWithComponents
```
public void insertPlainWithComponents()
```
 Inserts this object and all its components without any further processing.
 Same as AbstractDbObject.insertPlain() but with components.
 - insertPlainWithComponents
```
public int insertPlainWithComponents(Collection<? extends PersistentDomainObject<?>> objects)
```
 Inserts plain with components all objects of a collection.
 
 Parameters:
 
 objects - the collection of PDOs
 
 Returns:
 
 the number of objects processed
 - findDuplicate
```
public T findDuplicate()
```
 Checks whether this object (if saved) would violate any unique constraints.
 The method is usually used by the presentation layer to check for duplicates. The default implementation invokes findByUniqueDomainKey(getUniqueDomainKey()) and throws UnsupportedOperationException if one of those methods are not implemented (which is the default).
 
 Specified by:
 
 findDuplicate in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the duplicate object, null if no duplicate
 - isCacheable
```
public boolean isCacheable()
```
 Determines whether object is cacheable or not. The default implementation always returns true, but apps can use this as a filter.
 
 Specified by:
 
 isCacheable in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if object is cacheable
 - isExpired
```
public boolean isExpired()
```
 Checks whether object has been marked expired. Expired objects will be reloaded from the database by the cache when the object is retrieved again.
 
 Specified by:
 
 isExpired in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if object is expired (in cache)
 - setExpired
```
public void setExpired(boolean expired)
```
 Sets this object's expiration flag.
 
 Specified by:
 
 setExpired in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 expired - true if object is expired
 - getCacheAccessTime
```
public long getCacheAccessTime()
```
 Gets the last cache access time.
 
 Specified by:
 
 getCacheAccessTime in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the last cache access time
 - getCacheAccessCount
```
public long getCacheAccessCount()
```
 Gets the cache access count.
 
 Specified by:
 
 getCacheAccessCount in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the access count
 - markCacheAccess
```
public void markCacheAccess()
```
 mark cache access (count and set current system-time)
 
 Specified by:
 
 markCacheAccess in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isCached
```
public boolean isCached()
```
 Specified by:
 
 isCached in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if object is cached
 - getSecurityResult
```
public SecurityResult getSecurityResult(Permission permission)
```
 Specified by:
 
 getSecurityResult in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isPermissionAccepted
```
public boolean isPermissionAccepted(Permission permission)
```
 Specified by:
 
 isPermissionAccepted in interface PersistentObject<T extends PersistentDomainObject<T>>
 - createCopyInContext
```
public T createCopyInContext(DomainContext otherContext)
```
 Creates a new object as a copy of the current object in another (or the same) database context.
 The new context must be of the same class as the old one. Subclasses must override this method if they contain links to other objects (via IDs) that may have changed too (depending on the context).
 The default implementation just clones the object, sets the context and sets the original object (see getCopiedObject()).
 
 Specified by:
 
 createCopyInContext in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 otherContext - the database context
 
 Returns:
 
 the created object
 - getCopiedObject
```
public T getCopiedObject()
```
 Gets the original object if this object was created by createCopyInContext(org.tentackle.pdo.DomainContext).
 
 Specified by:
 
 getCopiedObject in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the object or null if this object is not a copy
 - saveCopyInContext
```
public T saveCopyInContext(DomainContext otherContext)
```
 Same as createCopyInContext(org.tentackle.pdo.DomainContext) but saves the new object within a transaction.
 
 Parameters:
 
 otherContext - the other domain context
 
 Returns:
 
 the created object
 - selectByTemplate
```
public T selectByTemplate(AbstractPersistentObject<T,P> template)
```
 Selects an object according to a template object. Useful to find corresponding objects in another context. The default implementation loads the same object by its ID. Should be overwridden to select by some other unique key.
 
 Parameters:
 
 template - the template object
 
 Returns:
 
 the object if found, else null.
 - copy
```
public T copy()
```
 Creates a "fast copy" of this object.
 The method is provided as a fast alternative to deep cloning via reflection or serialization.
 All database-attributes are copied in such a way that each attribute of the new object can be changed without modifying the state of the original object. This also applies to all related perstent objects along the object graph. Non-persistent objects or any other non-database attributes are initialized according to the object's constructor (i.e. will usually be initialized to false, 0 or null, respectively).
 The method will createPdo a new object (no clonePdo!) and set all attributes the same way as if the object has been loaded from storage.
 Notice that it differs semantically from createCopyInContext() as copy() will copy the identity (ID) from the source object as well and will retain the context. Thus, upon return we're talking about another instance of the "same" object with respect to what the database considers as "same".
 A copied object is always not modified and not deleted, as it is when loaded from the database.
 The default implementation throws a PersistenceException, i.e. the method must be overridden. See the PdoCopy wurblet for an implementation.
 
 Returns:
 
 the copied object
 - getEagerJoinedSelect
```
public JoinedSelect<T> getEagerJoinedSelect()
```
 Adds the eager joins to the created SQL.
 
 Returns:
 
 the processed code
 - readFromResultSetWrapper
```
public P readFromResultSetWrapper(ResultSetWrapper rs)
```
 Overridden to implement inheritance and adjust the domain context.
 
 Overrides:
 
 readFromResultSetWrapper in class AbstractDbObject>
 - executeQueryToList
```
public void executeQueryToList(PreparedStatementWrapper st,
 JoinedSelect<T> js,
 List<T> list)
```
 Executes the query for a prepared statement and adds the results to a list.
 
 Parameters:
 
 st - the query statement
 
 js - the joined select configuration, null if no joins
 
 list - the list
 - executeQueryToList
```
public void executeQueryToList(ResultSetWrapper rs,
 JoinedSelect<T> js,
 List<T> list)
```
 Executes the query for a prepared statement and adds the results to a list.
 
 Parameters:
 
 rs - the result set wrapper
 
 js - the joined select configuration, null if no joins
 
 list - the list
 - executeListQuery
```
public List<T> executeListQuery(PreparedStatementWrapper st,
 JoinedSelect<T> js)
```
 Executes the query for a prepared statement and returns the results in a list.
 
 Parameters:
 
 st - the query statement
 
 js - the joined select configuration, null if no joins
 
 Returns:
 
 the list
 - executeListQuery
```
public List<T> executeListQuery(PreparedStatementWrapper st)
```
 Executes the query for a prepared statement and returns the results in a list.
 
 Parameters:
 
 st - the query statement
 
 Returns:
 
 the list
 - executeTrackedListQuery
```
public org.tentackle.misc.TrackedList<T> executeTrackedListQuery(PreparedStatementWrapper st,
 JoinedSelect<T> js)
```
 Executes the query for a prepared statement and returns the results in a tracked list.
 
 Parameters:
 
 st - the query statement
 
 js - the joined select configuration, null if no joins
 
 Returns:
 
 the tracked list
 - executeTrackedListQuery
```
public org.tentackle.misc.TrackedList<T> executeTrackedListQuery(PreparedStatementWrapper st)
```
 Executes the query for a prepared statement and returns the results in a tracked list.
 
 Parameters:
 
 st - the query statement
 
 Returns:
 
 the tracked list
 - getEagerJoins
```
public List<Join<? super T,?>> getEagerJoins()
```
 Returns the eager joins for this PDO.
 
 Returns:
 
 the list of eager joins, null if none
 - readJoinedRow
```
public void readJoinedRow(ResultSetWrapper rs,
 JoinedSelect<T> js)
```
 Reads the next row from a result set within a joined select.
 The results may come in any order. Thus, it is possible to sort the results according the to the domain's requirements.
 
 Parameters:
 
 js - the joined select
 
 rs - the result set
 - executeFirstPdoQuery
```
public T executeFirstPdoQuery(PreparedStatementWrapper st,
 JoinedSelect<T> js)
```
 Executes a query for a prepared statement and returns the first PDO.
 
 Parameters:
 
 st - the query statement
 
 js - the joined select configuration, null if no joins
 
 Returns:
 
 the PDO
 - executeFirstPdoQuery
```
public T executeFirstPdoQuery(PreparedStatementWrapper st)
```
 Executes a query for a prepared statement and returns the first PDO.
 
 Parameters:
 
 st - the query statement
 
 Returns:
 
 the PDO
 - select
```
public T select(long id,
 boolean locked)
```
 Loads a PDO from the database by its unique ID.
 
 Parameters:
 
 id - is the object id
 
 locked - true if select FOR UPDATE
 
 Returns:
 
 object if loaded, null if no such object
 - setClassIdsInStatement
```
protected int setClassIdsInStatement(JoinedSelect<T> js,
 PreparedStatementWrapper st,
 int ndx)
```
 Sets the class-ID parameters if required for the joins.
 Notice that this method only works for joins with no subjoins and is used only for eager joins, i.e. the default selects. All code for non-eager joins is generated via the DbModelWurblet.
 
 Parameters:
 
 st - the statement
 
 ndx - the next parameter ndx
 
 Returns:
 
 the next parameter index
 - select
```
public T select(long id)
```
 Loads a PDO from the database by its unique ID.
 
 Specified by:
 
 select in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 id - is the object id
 
 Returns:
 
 object if loaded, null if no such object
 - reload
```
public T reload()
```
 Reloads the object.
 Note: to make sure that any lazy inits are cleared, the returned object is always a new object.
 
 Specified by:
 
 reload in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the object if reloaded, else null (never this)
 - reloadLocked
```
public T reloadLocked()
```
 Reloads the object with a write lock. Note: to make sure that any lazy inits are cleared, the returned object is always a new object.
 
 Specified by:
 
 reloadLocked in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the object if reloaded, else null (never this)
 - selectLocked
```
public T selectLocked(long id)
```
 Loads and write-locks a PDO from the database by its unique ID.
 
 Specified by:
 
 selectLocked in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 id - is the object id
 
 Returns:
 
 object if loaded, null if no such object
 - derivePdoFromPo
```
public T derivePdoFromPo(T pdo,
 P po)
```
 Derive the concrete PDO from a given PO.
 
 Parameters:
 
 pdo - the original persistent domain object
 
 po - the effective persistent object from readFromResultSetWrapper
 
 Returns:
 
 the persistent domain object, null if no read permission
 - assertRootContextIsAccepted
```
public void assertRootContextIsAccepted()
```
 Checks the root context agains the security rules.
 - createSelectAllInnerSql
```
public StringBuilder createSelectAllInnerSql()
```
 Overrides:
 
 createSelectAllInnerSql in class AbstractDbObject>
 - createSelectAllIdSerialInnerSql
```
public StringBuilder createSelectAllIdSerialInnerSql()
```
 Overrides:
 
 createSelectAllIdSerialInnerSql in class AbstractDbObject>
 - createSelectAllByIdInnerSql
```
public StringBuilder createSelectAllByIdInnerSql()
```
 Overrides:
 
 createSelectAllByIdInnerSql in class AbstractDbObject>
 - createSelectIdInnerSql
```
public StringBuilder createSelectIdInnerSql(PersistentObjectClassVariables<? super T,? super P> classVariables,
 boolean withAlias)
```
 Creates the inner sql text to select the ID field.
 Returns something like:
```
 "id FROM xytable WHERE 1=1"
 
```
 Parameters:
 
 classVariables - the classvariables
 
 withAlias - true if column name with table alias, else without
 
 Returns:
 
 the sql text
 - createSelectIdInnerSql
```
public StringBuilder createSelectIdInnerSql(boolean withAlias)
```
 Creates the inner sql text to select the ID field.
 Returns something like:
```
 "id FROM xytable WHERE 1=1"
 
```
 Parameters:
 
 withAlias - true if column name with table alias, else without
 
 Returns:
 
 the sql text
 - createSelectIdInnerSql
```
public StringBuilder createSelectIdInnerSql()
```
 Overrides:
 
 createSelectIdInnerSql in class AbstractDbObject>
 - createSelectByNormTextSql
```
public String createSelectByNormTextSql()
```
 Creates the SQL code for select by normtext.
 
 Returns:
 
 the sql code
 - createSelectSerialSql
```
public String createSelectSerialSql()
```
 Creates the SQL code for the selectSerial statement.
 
 Overrides:
 
 createSelectSerialSql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - createSelectMaxIdSql
```
public String createSelectMaxIdSql()
```
 Creates the SQL code for the selectMaxId statement.
 
 Overrides:
 
 createSelectMaxIdSql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - createSelectMaxTableSerialSql
```
public String createSelectMaxTableSerialSql()
```
 Creates the SQL code for the selectMaxTableSerial statement.
 
 Overrides:
 
 createSelectMaxTableSerialSql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - createDummyUpdateSql
```
public String createDummyUpdateSql()
```
 Creates the SQL code for the dummy update statement.
 Useful get an exclusive lock within a transaction.
 
 Overrides:
 
 createDummyUpdateSql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - createUpdateSerialSql
```
public String createUpdateSerialSql()
```
 Creates the SQL code for the serial update statement.
 
 Overrides:
 
 createUpdateSerialSql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - createUpdateSerialAndTableSerialSql
```
public String createUpdateSerialAndTableSerialSql()
```
 Creates the SQL code for the serial + tableSerial update statement.
 
 Overrides:
 
 createUpdateSerialAndTableSerialSql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - createSelectExpiredTableSerials1Sql
```
public String createSelectExpiredTableSerials1Sql()
```
 Creates the SQL code for the first statement to select expired table serials.
 
 Overrides:
 
 createSelectExpiredTableSerials1Sql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - createSelectExpiredTableSerials2Sql
```
public String createSelectExpiredTableSerials2Sql()
```
 Creates the SQL code for the second statement to select expired table serials.
 
 Overrides:
 
 createSelectExpiredTableSerials2Sql in class AbstractDbObject>
 
 Returns:
 
 the sql code
 - resultByNormText
```
public ResultSetWrapper resultByNormText(String normText,
 JoinedSelect<T> js)
```
 Gets the result set for the normtext query (where normtext like ?) for use in lists.
 If the given normtext is null or just "%" the method falls back to resultAll(org.tentackle.persist.JoinedSelect<T>).
 
 Parameters:
 
 normText - the normtext to search for
 
 js - the optional join config, null if no joins
 
 Returns:
 
 the result set
 
 See Also:
 
 resultByNormTextCursor(java.lang.String, org.tentackle.persist.JoinedSelect<T>)
 - resultByNormTextCursor
```
public ResultSetWrapper resultByNormTextCursor(String normText,
 JoinedSelect<T> js)
```
 Gets the result set for the normtext query (where normtext like ?) for use in cursors.
 Cursors differ from lists because they need ResultSet.TYPE_SCROLL_INSENSITIVE set. If the given normtext is null or just "%" the method falls back to resultAll(org.tentackle.persist.JoinedSelect<T>).
 
 Parameters:
 
 normText - the normtext to search for
 
 js - the optional join config, null if no joins
 
 Returns:
 
 the result set
 
 See Also:
 
 resultByNormText(java.lang.String, org.tentackle.persist.JoinedSelect<T>)
 - selectByNormText
```
public List<T> selectByNormText(String normText)
```
 Selects all objects with a given normtext as a list.
 
 Specified by:
 
 selectByNormText in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 normText - the normtext
 
 Returns:
 
 the list of objects, never null
 
 See Also:
 
 resultByNormText(java.lang.String, org.tentackle.persist.JoinedSelect<T>)
 - selectByNormTextAsCursor
```
public org.tentackle.misc.ScrollableResource<T> selectByNormTextAsCursor(String normText)
```
 Selects all objects with a given normtext as a cursor.
 
 Specified by:
 
 selectByNormTextAsCursor in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 normText - the normtext
 
 Returns:
 
 the cursor
 
 See Also:
 
 resultByNormTextCursor(java.lang.String, org.tentackle.persist.JoinedSelect<T>)
 - createSelectAllSql
```
public String createSelectAllSql()
```
 Creates SQL code for select all.
 Appends context condition and order by clause if configured.
 
 Returns:
 
 the sql code
 - createSelectAllWithExpiredTableSerialsSql
```
public String createSelectAllWithExpiredTableSerialsSql()
```
 Creates SQL code for selectAllWithExpiredTableSerials(long).
 Appends context condition and order by clause if configured.
 By default, the result is sorted by tableserial + id.
 
 Returns:
 
 the sql code
 - resultAll
```
public ResultSetWrapper resultAll(JoinedSelect<T> js)
```
 Gets the result set for all objects in the current context for use in lists.
 
 Parameters:
 
 js - the optional join config, null if no joins
 
 Returns:
 
 the result set
 
 See Also:
 
 resultAllCursor(org.tentackle.persist.JoinedSelect<T>)
 - resultAllWithExpiredTableSerials
```
public ResultSetWrapper resultAllWithExpiredTableSerials(JoinedSelect<T> js,
 long oldSerial)
```
 Gets the result set for all objects in the current context with a given expired tableserial.
 
 Parameters:
 
 js - the optional join config, null if no joins
 
 Returns:
 
 the result set
 - resultAllCursor
```
public ResultSetWrapper resultAllCursor(JoinedSelect<T> js)
```
 Gets the result set for all objects in the current context for use in cursors.
 Cursors differ from lists because they need ResultSet.TYPE_SCROLL_INSENSITIVE set.
 
 Parameters:
 
 js - the optional join config, null if no joins
 
 Returns:
 
 the result set
 
 See Also:
 
 resultAll(org.tentackle.persist.JoinedSelect<T>)
 - selectAll
```
public List<T> selectAll()
```
 Selects all records in current context as a list.
 
 Specified by:
 
 selectAll in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the list of objects, never null
 
 See Also:
 
 resultAll(org.tentackle.persist.JoinedSelect<T>)
 - selectAllWithExpiredTableSerials
```
public List<T> selectAllWithExpiredTableSerials(long oldSerial)
```
 Specified by:
 
 selectAllWithExpiredTableSerials in interface PersistentObject<T extends PersistentDomainObject<T>>
 - selectAllAsCursor
```
public org.tentackle.misc.ScrollableResource<T> selectAllAsCursor()
```
 Selects all records in current context as a cursor
 
 Specified by:
 
 selectAllAsCursor in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the cursor
 
 See Also:
 
 resultAllCursor(org.tentackle.persist.JoinedSelect<T>)
 - getCache
```
public PdoCache<T> getCache()
```
 Gets the cache. The default implementation returns null. Must be overridden to enable optimization features with RMI servers.
 
 Specified by:
 
 getCache in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the cache, null if uncached
 - expireCache
```
public boolean expireCache(long maxSerial)
```
 Expires the cache according to the serial numbers.
 If objects of this class are cached, the cache must be expired on updates, etc... Furthermore, if there is a cache, isCountingModification() MUST return true, in order for countModification() to invalidate the cache for the local JVM. Classes with a cache must override this method! The implementation with the PdoCache should look like this:
```
 cache.expire(maxSerial);
 
```
 while "cache" has been declared by the wurblet PdoCache.
 Parameters:
 
 maxSerial - is the new tableSerial this object will get
 
 Returns:
 
 true if cache invalidated, false if there is no cache
 
 See Also:
 
 PdoCache
 - selectCached
```
public T selectCached(long id)
```
 Gets the object via cache.
 If there is no cache (i.e. the method is not overridden), the default implementation just loads from the db.
 
 Specified by:
 
 selectCached in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 id - the uniue object ID
 
 Returns:
 
 the object, null if no such object
 
 See Also:
 
 AbstractDbObject.selectObject(long)
 - selectCachedOnly
```
public T selectCachedOnly(long id)
```
 Gets the object via cache only.
 If there is no cache (i.e. the method is not overridden), the default implementation just loads from the db.
 
 Specified by:
 
 selectCachedOnly in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 id - the uniue object ID
 
 Returns:
 
 the object, null if no such object
 
 See Also:
 
 AbstractDbObject.selectObject(long)
 - selectAllCached
```
public List<T> selectAllCached()
```
 Gets all objects in context via cache. If there is no cache (i.e. the method is not overridden), the default implementation gets it from the db.
 
 Specified by:
 
 selectAllCached in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the list, never null
 
 See Also:
 
 selectAll()
 - selectAllForCache
```
public List<T> selectAllForCache()
```
 Specified by:
 
 selectAllForCache in interface PersistentObject<T extends PersistentDomainObject<T>>
 - selectForCache
```
public T selectForCache(long id)
```
 Specified by:
 
 selectForCache in interface PersistentObject<T extends PersistentDomainObject<T>>
 - countModification
```
public long countModification()
```
 Overridden to expire the cache if object is using the tableserial.
 
 Overrides:
 
 countModification in class AbstractDbObject>
 - addReferencingClass
```
public <R extends PersistentDomainObject<R>> boolean addReferencingClass(Class<R> clazz,
 String methodName)
```
 Adds a PDO class that is referencing this PDO clazz.
 
 Type Parameters:
 
 R - the PDO type
 
 Parameters:
 
 clazz - the class to add
 
 methodName - a method name, null if default
 
 Returns:
 
 true if added, false if already in map
 
 See Also:
 
 removeReferencingClass(java.lang.Class<R>, java.lang.String)
 - removeReferencingClass
```
public <R extends PersistentDomainObject<R>> boolean removeReferencingClass(Class<R> clazz,
 String methodName)
```
 Removes a PDO class that is referencing this PDO clazz.
 
 Type Parameters:
 
 R - the PDO type
 
 Parameters:
 
 clazz - the class to add
 
 methodName - a method name, null if default
 
 Returns:
 
 true if removed, false if not in map
 
 See Also:
 
 removeReferencingClass(java.lang.Class<R>, java.lang.String)
 - getPersistenceClass
```
public <R extends PersistentDomainObject<R>> Class<? extends AbstractPersistentObject<?,?>> getPersistenceClass(Class<R> clazz)
```
 Gets the persistence class from a pdo class.
 Throws a PersistenceException if the persistence class is not an AbstractPersistentObject.
 
 Type Parameters:
 
 R - the PDO type
 
 Parameters:
 
 clazz - the pdo class
 
 Returns:
 
 the persistence class
 - isReferenced
```
public boolean isReferenced()
```
 Overridden because remote method requires a DomainContext instead of just the db-connection.
 
 Specified by:
 
 isReferenced in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Overrides:
 
 isReferenced in class AbstractDbObject>
 - containsPattern
```
public boolean containsPattern(String pattern)
```
 Searches for a "pattern" in this object.
 The default implementation looks for the pattern in the normtext.
 
 Specified by:
 
 containsPattern in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 pattern - the pattern to search for
 
 Returns:
 
 true if this object "contains" the pattern
 - orderBy
```
public String orderBy()
```
 Gets the natural ordering to be added in WHERE-clauses following "ORDER BY ". The wurblets will use it if --sort option set. Example:
```
 return CN_ID + "," + CN_PRINTED + " DESC";
 
```
 For a single field with sort ascending returning the fieldname is sufficient. The default is null, i.e. no order-by-clause will be added.
 Returns:
 
 the order by appendix string, null if no order by
 - initModification
```
public void initModification(char modType)
```
 Overridden due to security check.
 
 Overrides:
 
 initModification in class AbstractDbObject>
 - finishModification
```
public void finishModification(char modType)
```
 Overridden to clear the renewTokenLock flag.
 
 Overrides:
 
 finishModification in class AbstractDbObject>
 - finishNotUpdated
```
public void finishNotUpdated(char modType)
```
 Ovewritten to get the token lock removed, if any.
 
 Overrides:
 
 finishNotUpdated in class AbstractDbObject>
 - getContextUserId
```
public long getContextUserId()
```
 Gets the user id from the current context, i.e. userinfo.
 Note: invokes the errorhandler if some exception or userId is 0.
 
 Returns:
 
 the userId
 - clearTokenLock
```
public void clearTokenLock()
```
 Clears or renews the token lock.
 If isRenewTokenLockRequested() is true, the token will be renewed (prolonged if existing) or created (if not existing). The operation is only done in memory, not in persistent storage.
 - setRenewTokenLockRequested
```
public void setRenewTokenLockRequested(boolean renewTokenLock)
```
 Sets whether to apply or renew the token lock on insert or update.
 By default, the token lock (if set) will be cleared upon insert or update. However, sometimes it is necessary to keep it, renew it respectively.
 Setting this flag to true will renew the token upon the next persistence operation. Afterwards the flag will be cleared.
 
 Parameters:
 
 renewTokenLock - true to renew the token (once)
 - isRenewTokenLockRequested
```
public boolean isRenewTokenLockRequested()
```
 Determines whether to renew the token lock on saveImpl or update.
 
 Returns:
 
 true to renew the token (once), false to clear token (default)
 - isUpdateNecessary
```
protected boolean isUpdateNecessary()
```
 Overrides:
 
 isUpdateNecessary in class AbstractDbObject>
 - updateObject
```
public void updateObject()
```
 Overridden to clear the token lock if remote session.
 
 Overrides:
 
 updateObject in class AbstractDbObject>
 - insertObject
```
public void insertObject()
```
 Overridden to clear the token lock if remote session.
 
 Overrides:
 
 insertObject in class AbstractDbObject>
 - newId
```
public void newId()
```
 Overrides:
 
 newId in class AbstractDbObject>
 - updateRootContext
```
public boolean updateRootContext()
```
 Updates the root context.
 Method is used after deserialization.
 
 Returns:
 
 true if root context set, false if this is not a root-entity
 - configureRemoteObject
```
public void configureRemoteObject(DomainContext context,
 T obj)
```
 Configures the remotely retrieved object.
 
 Parameters:
 
 context - the local domain context
 
 obj - the object
 - configureRemoteObjects
```
public void configureRemoteObjects(DomainContext context,
 Collection<T> objects)
```
 Configures the remotely retrieved objects.
 
 Parameters:
 
 context - the local domain context
 
 objects - the objects to configure
 - assertRootContext
```
protected void assertRootContext()
```
 Asserts that the po's context is a root context.
 - markDeleted
```
protected <X extends PersistentDomainObject<X>> void markDeleted(Collection<X> pdos)
```
 Marks all objects in a list to be deleted.
 This method is provided to mark components in PDOs only. This method must not be used from within the application!
 
 Type Parameters:
 
 X - the pdo type
 
 Parameters:
 
 pdos - the objects to mark deleted
 - markDeleted
```
protected void markDeleted(PersistentDomainObject<?> pdo)
```
 Marks an object to be deleted.
 This method is provided to mark components in PDOs only. This method must not be used from within the application!
 
 Parameters:
 
 pdo - the pdo to mark deleted
 - delete
```
protected <X extends PersistentDomainObject<X>> void delete(Collection<X> pdos)
```
 Deletes a List of objects.
 This method is provided to mark components in PDOs only. This method must not be used from within the application!
 
 Type Parameters:
 
 X - the pdo type
 
 Parameters:
 
 pdos - the list of object to delete
 - delete
```
protected void delete(PersistentDomainObject<?> pdo)
```
 Deletes a PDO.
 This method is provided to save components in PDOs only. This method must not be used from within the application!
 
 Parameters:
 
 pdo - the pdo to mark deleted
 - deleteMissingInCollection
```
protected <X extends PersistentDomainObject<X>> void deleteMissingInCollection(Collection<X> oldCollection,
 Collection<X> newCollection)
```
 Deletes all objects in oldList that are not in newList.
 This method is provided to save components in PDOs only. This method must not be used from within the application!
 
 Type Parameters:
 
 X - the PDO type
 
 Parameters:
 
 oldCollection - the list of objects stored in db
 
 newCollection - the new list of objects
 - assertRootEntity
```
public void assertRootEntity()
```
 Checks if the po is a root entity.
 - delete
```
public void delete()
```
 Specified by:
 
 delete in interface PersistentObject<T extends PersistentDomainObject<T>>
 - deleteImpl
```
protected void deleteImpl()
```
 Implementation of delete bypassing the invocation handler.
 - save
```
public void save()
```
 Specified by:
 
 save in interface PersistentObject<T extends PersistentDomainObject<T>>
 - saveImpl
```
protected void saveImpl()
```
 Implementation of save bypassing the invocation handler.
 - save
```
protected <X extends PersistentDomainObject<X>> void save(Collection<X> pdos,
 boolean modifiedOnly)
```
 Saves a list of PDOs.
 This method is provided to save components in PDOs only. Assumes that a transaction is already running. This method must not be used from within the application!
 
 Type Parameters:
 
 X - the pdo type
 
 Parameters:
 
 pdos - the list to save
 
 modifiedOnly - true if only modified objects are saved
 - save
```
protected void save(PersistentDomainObject<?> pdo)
```
 Saves a PDO.
 This method is provided to save components in PDOs only. This method must not be used from within the application!
 
 Parameters:
 
 pdo - the pdo to save
 - persist
```
public T persist()
```
 Specified by:
 
 persist in interface PersistentObject<T extends PersistentDomainObject<T>>
 - persistTokenLocked
```
public T persistTokenLocked()
```
 Specified by:
 
 persistTokenLocked in interface PersistentObject<T extends PersistentDomainObject<T>>
 - persistImpl
```
protected T persistImpl()
```
 Implementation of persist bypassing the invocation handler.
 
 Returns:
 
 the persisted PDO
 - isUpdatingSerialEvenIfNotModified
```
public boolean isUpdatingSerialEvenIfNotModified()
```
 Determines whether in updates of composite objects unmodified objects in the update path get at least the serial updated or are not touched at all. The default is to leave unmodified objects untouched, except root entities. However, in some applications it is necessary to update the master object if some of its childs are updated (usually to trigger something, e.g. a cache-update).
 The default implementation returns true if this is a root entity.
 
 Overrides:
 
 isUpdatingSerialEvenIfNotModified in class AbstractDbObject>
 
 Returns:
 
 true if update serial even if object is unchanged
 
 See Also:
 
 updateObject()
 - isModified
```
protected <X extends PersistentDomainObject<X>> boolean isModified(Collection<X> pdos)
```
 Checks whether some of the objects in the list are modified.
 This method is provided to save components in PDOs only. Assumes that a transaction is already running. This method must not be used from within the application!
 
 Type Parameters:
 
 X - the PDO type
 
 Parameters:
 
 pdos - the objects
 
 Returns:
 
 true if modified
 - isTokenLockProvided
```
public boolean isTokenLockProvided()
```
 By default objects don't need to include the editedBy/Since/Expiry columns in the database table. Override this method if object contains such columns, i.e. global model option [TOKENLOCK] set.
 
 Specified by:
 
 isTokenLockProvided in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if object is using the edited lock columns, false if not.
 - assertTokenLockProvided
```
protected void assertTokenLockProvided()
```
 Asserts that entity provides a normtext.
 - getTokenLockTimeout
```
public long getTokenLockTimeout()
```
 Gets the expiration in milliseconds of the "being-edited-token" if this object should request such a token when being edited.
 
 Specified by:
 
 getTokenLockTimeout in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the timespan in ms, 0 = no token required.
 - createUpdateTokenLockSql
```
public String createUpdateTokenLockSql()
```
 Creates the SQL code for the updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp) statement.
 
 Returns:
 
 the sql code
 - createUpdateTokenLockWithCountSql
```
public String createUpdateTokenLockWithCountSql()
```
 Creates the SQL code for the updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp) statement with mod counting.
 
 Returns:
 
 the sql code
 - createUpdateTokenLockOnlySql
```
public String createUpdateTokenLockOnlySql()
```
 Creates the SQL code for the updateTokenLockOnly() statement.
 
 Returns:
 
 the sql code
 - createSelectTokenLockSql
```
public String createSelectTokenLockSql()
```
 Creates the SQL code for the select in updateTokenLock(org.tentackle.common.Timestamp, long, org.tentackle.common.Timestamp) statement.
 
 Returns:
 
 the sql code
 - createTransferTokenLockSql
```
public String createTransferTokenLockSql()
```
 Creates the SQL code for the transferTokenLock(long) statement without tableserial.
 
 Returns:
 
 the sql code
 - createTransferTokenLockWithTableSerialSql
```
public String createTransferTokenLockWithTableSerialSql()
```
 Creates the SQL code for the transferTokenLock(long) statement with tableserial.
 
 Returns:
 
 the sql code
 - getEditedBy
```
public long getEditedBy()
```
 Gets the id of the user currently editing this object.
 
 Specified by:
 
 getEditedBy in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the id or 0 if not being edited currently.
 - setEditedBy
```
public void setEditedBy(long editedBy)
```
 Sets the user editing this object.
 Does *NOT* alter isModified() and does not require the object to be mutable.
 
 Specified by:
 
 setEditedBy in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 editedBy - the id of the user, 0 to clear.
 - requestTokenLock
```
public void requestTokenLock()
```
 Requests an edited by lock.
 
 Specified by:
 
 requestTokenLock in interface PersistentObject<T extends PersistentDomainObject<T>>
 - releaseTokenLock
```
public void releaseTokenLock()
```
 Releases an edited by lock.
 Use this method if a PDO needs to be unlocked without being persisted.
 
 Specified by:
 
 releaseTokenLock in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isTokenLocked
```
public boolean isTokenLocked()
```
 Checks whether this object is token locked (editedBy != 0) and the lock is not expired.
 
 Specified by:
 
 isTokenLocked in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if locked by any user
 - isTokenLockedBy
```
public boolean isTokenLockedBy(long userId)
```
 Checks whether this object is edited locked by given user.
 
 Specified by:
 
 isTokenLockedBy in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 userId - the user's ID
 
 Returns:
 
 true locked
 - isTokenLockedByMe
```
public boolean isTokenLockedByMe()
```
 Checks whether this object is edited locked by the current user.
 
 Specified by:
 
 isTokenLockedByMe in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 true if locked
 - getEditedSince
```
public org.tentackle.common.Timestamp getEditedSince()
```
 Gets the time since when this object is being edited.
 
 Specified by:
 
 getEditedSince in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the time, null if not being edited.
 - setEditedSince
```
public void setEditedSince(org.tentackle.common.Timestamp editedSince)
```
 Sets the time since when this object is being edited.
 Does *NOT* alter isModified() and does not require the object to be mutable.
 
 Specified by:
 
 setEditedSince in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 editedSince - the time, null to clear.
 - getEditedExpiry
```
public org.tentackle.common.Timestamp getEditedExpiry()
```
 Gets the time since when this object is being edited.
 
 Specified by:
 
 getEditedExpiry in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the time, null if not being edited.
 - setEditedExpiry
```
public void setEditedExpiry(org.tentackle.common.Timestamp editedExpiry)
```
 Sets the time when the token should expire.
 Does *NOT* alter isModified() and does not require the object to be mutable.
 
 Specified by:
 
 setEditedExpiry in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 editedExpiry - the expiration time, null to clear.
 - getTokenLockObject
```
public > U getTokenLockObject()
```
 Gets the object associated to the id of the editedBy-attribute.
 This is usually the id of a persistent Object implementing the concept of a user, group, role or whatever. The default implementation invokes AbstractApplication.getUser(org.tentackle.pdo.DomainContext, long).
 
 Specified by:
 
 getTokenLockObject in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the user object, null if no user or id was 0
 - setTokenLockObject
```
public > void setTokenLockObject(U obj)
```
 Sets the user/group/role-object editing this object.
 
 Specified by:
 
 setTokenLockObject in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 obj - the object, null to clear.
 - isCountingModificationForTokenLock
```
public boolean isCountingModificationForTokenLock()
```
 - updateTokenLock
```
public void updateTokenLock(org.tentackle.common.Timestamp tokenExpiry,
 long userId,
 org.tentackle.common.Timestamp curTime)
```
 Updates token lock columns in db-record.
 Will *NOT* log modification and *NOT* update the serial-counter! Must be called from within application where appropriate.
 2 cases:
 If expiry == 0, the "token" is released. True is returned if operation was successful and editedBy will hold 0 while editedSince holds the current (release) time. False is returned if token could not be released and nothing is changed. This usually is the case when another user holds the token (and indicates some logic errors in the application, btw.) EditedBy and editedSince are updated in the object to reflect the current values in the database. Notice: releasing an already released token is not considered to be an error. This will simply update the release timestamp.
 If expiry > 0, a new token for the current user is requested. True is returned if the token could be exclusively acquired. EditedBy and editedSince are updated accordingly. If false: the object is in use by another user and editedSince and editedId holds this user and his timestamp. Notice: requesting an already requested token will simply renew the token.
 The method does not check getTokenLockTimeout()! This is due to the application. Applications should use updateTokenLock(tokenExpiry). This is an internal implementation only.
 
 Parameters:
 
 tokenExpiry - holds the time the token will expire. Null to release token.
 
 userId - is the current user (unused if tokenExpiry is null)
 
 curTime - is the current system time
 - updateTokenLock
```
public void updateTokenLock(org.tentackle.common.Timestamp tokenExpiry)
```
 Updates editing info in db-record (if feature enabled).
 Will *NOT* log modification and *NOT* update the serial-counter! Must be called from within application where appropriate. See PdoEditDialog.
 2 cases:
 If expiry == 0, the "token" is released. True is returned if operation was successful and editedBy will hold 0 while editedSince holds the current (release) time. False is returned if token could not be released and nothing is changed. This usually is the case when another user holds the token (and indicates some logic errors in the application, btw.) EditedBy and editedSince are updated in the object to reflect the current values in the database. Notice: releasing an already released token is not considered to be an error. This will simply update the release timestamp.
 If expiry > 0, a new token for the current user is requested. True is returned if the token could be exclusively acquired. EditedBy and editedSince are updated accordingly. If false: the object is in use by another user and editedSince and editedId holds this user and his timestamp. Notice: requesting an already requested token will simply renew the token.
 The method does not check getTokenLockTimeout()! This is due to the application.
 
 Parameters:
 
 tokenExpiry - holds the time the token will expire. Null to release token.
 - updateTokenLockOnly
```
public void updateTokenLockOnly()
```
 Update the editedBy-attributes to persistent storage.
 No check is done whether locked or not and there is no serial update and no modlog. Used by daemons to cleanup.
 - transferTokenLock
```
public T transferTokenLock(long userId)
```
 Specified by:
 
 transferTokenLock in interface PersistentObject<T extends PersistentDomainObject<T>>
 - getTransientData
```
public Object getTransientData()
```
 Gets the optional transient data object.
 The default implementation does nothing.
 
 Specified by:
 
 getTransientData in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Returns:
 
 the transient data, null if none.
 - setTransientData
```
public void setTransientData(Object data)
```
 Sets the optional transient data object.
 Sometimes, e.g. when objects need to be reloaded from storage, all non-persistent data attached to the object would be lost. In such cases the framework invokes getTransientData() and setTransientData() to keep the non-persistent attributes.
 The default implementation does nothing.
 
 Specified by:
 
 setTransientData in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Parameters:
 
 data - the transient data
 - getRemoteDelegate
```
public org.tentackle.persist.rmi.AbstractPersistentObjectRemoteDelegate<T,P> getRemoteDelegate()
```
 Overridden due to covariance.
 
 Overrides:
 
 getRemoteDelegate in class AbstractDbObject>
 - getDefaultScopes
```
public Class<? extends org.tentackle.validate.ValidationScope>[] getDefaultScopes()
```
 The default scopes are: PersistenceScope, MandatoryScope and ChangeableScope.
 
 Specified by:
 
 getDefaultScopes in interface org.tentackle.validate.ScopeConfigurator
 - validate
```
public List<org.tentackle.validate.ValidationResult> validate(String validationPath,
 org.tentackle.validate.ValidationScope scope)
```
 Specified by:
 
 validate in interface org.tentackle.validate.Validateable
 - validate
```
public void validate()
```
 Specified by:
 
 validate in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isValidated
```
public boolean isValidated()
```
 Specified by:
 
 isValidated in interface PersistentObject<T extends PersistentDomainObject<T>>
 - setModified
```
public void setModified(boolean modified)
```
 Specified by:
 
 setModified in interface PersistentObject<T extends PersistentDomainObject<T>>
 
 Overrides:
 
 setModified in class AbstractDbObject>
 - isReadAllowed
```
public boolean isReadAllowed()
```
 Determines whether the application is allowed to read this PDO.
 Makes no sense to publish in PersistentObject because PDOs without read permissions are not read from the database at all.
 
 Returns:
 
 true if allowed
 - isWriteAllowed
```
public boolean isWriteAllowed()
```
 Specified by:
 
 isWriteAllowed in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isViewAllowed
```
public boolean isViewAllowed()
```
 Specified by:
 
 isViewAllowed in interface PersistentObject<T extends PersistentDomainObject<T>>
 - isEditAllowed
```
public boolean isEditAllowed()
```
 Specified by:
 
 isEditAllowed in interface PersistentObject<T extends PersistentDomainObject<T>>
 - assertWritePermission
```
protected void assertWritePermission()
```
 Checks write permission for this object.
 
 Throws:
 
 SecurityException - if no write permission
 - assertReadPermission
```
protected void assertReadPermission()
```
 Checks read permission for this object.
 
 Throws:
 
 SecurityException - if no read permission

Class AbstractPersistentObject<T extends PersistentDomainObject<T>,P extends AbstractPersistentObject<T,P>>

Field Summary

Fields inherited from class org.tentackle.dbms.AbstractDbObject

Constructor Summary

Method Summary

Methods inherited from class org.tentackle.dbms.AbstractDbObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.tentackle.pdo.PersistentObject

Methods inherited from interface org.tentackle.pdo.PdoHolder

Methods inherited from interface org.tentackle.misc.Identifiable

Methods inherited from interface org.tentackle.misc.Modifiable

Methods inherited from interface org.tentackle.misc.SerialNumbered

Methods inherited from interface org.tentackle.pdo.DomainContextProvider

Methods inherited from interface org.tentackle.session.SessionDependable

Methods inherited from interface org.tentackle.session.SessionProvider

Methods inherited from interface org.tentackle.reflect.EffectiveClassProvider

Methods inherited from interface org.tentackle.dbms.ModificationLoggable

Field Detail

objectIsSnapshot

CN_EDITEDBY

AN_EDITEDBY

CN_EDITEDEXPIRY

AN_EDITEDEXPIRY

CN_EDITEDSINCE

AN_EDITEDSINCE

CN_NORMTEXT

AN_NORMTEXT

CN_ROOTID

AN_ROOTID

CN_ROOTCLASSID

AN_ROOTCLASSID

TX_SAVE_COPY_IN_CONTEXT

TX_DELETE_ALL_IN_CONTEXT

TX_TRANSFER_TOKENLOCK

Constructor Detail

AbstractPersistentObject

AbstractPersistentObject

AbstractPersistentObject

AbstractPersistentObject

Method Detail

getDomainDelegate

getPdo

pdo

setPdo

getEffectiveClass

getEffectiveSuperClasses

clone

clonePersistentObject

findSnapshotMethod

createSnapshot

createAttributesInSnapshot

createComponentsInSnapshot

revertToSnapshot

revertAttributesToSnapshot

revertComponentsToSnapshot

isSnapshot

getSnapshots

addSnapshot

assertValidSnapshot

assertNotCached

assertMutable

isPersistable

setPersistable

assertPersistable

createPropertySupport

isRootEntity

isRootIdProvided

getRootId

setRootId

isRootClassIdProvided

getRootClassId

setRootClassId

isRootEntityOf

isNormTextProvided

assertNormTextProvided

setNormText

getNormText

isDomainContextImmutable

setDomainContextImmutable

assertDomainContextMutable