EntityBase (asdk-db-service 2.0.0 API)

java.lang.Object
- net.as_development.asdk.db_service.EntityBase

All Implemented Interfaces:

Serializable, Cloneable, IEntity
```
public class EntityBase
extends Object
implements IEntity
```
provides basic functionality for all DB entities. Can be used as base class for those entities impl classes.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTRIBUTE_NAME_EXPIRE`
`static String`	`ATTRIBUTE_NAME_ID`
`static String`	`ATTRIBUTE_NAME_MODIFY_STAMP`
`static String`	`ATTRIBUTE_NAME_REMOVED`
`static String`	`COLUMN_NAME_EXPIRE`
`static String`	`COLUMN_NAME_ID`
`static String`	`COLUMN_NAME_MODIFY_STAMP`
`static String`	`COLUMN_NAME_REMOVED`
`Long`	`Expire` Special feature to let entities expire after the specified amount of time.
`String`	`ExternalId` Sometimes the outside code wish to use it's own ID instead of generating a new one all the time.
`String`	`Id`
`Date`	`ModifyStamp` Special feature to know when a DB entry was modified last time.
`String`	`PreId` help the DB back end to track the process of generating IDs within error prone transactions.
`boolean`	`Removed` Interims feature to know 'removed' items in DB ...

Constructor Summary

Constructors
Constructor and Description

EntityBase()
create new instance.

Constructors
Constructor and Description
`EntityBase()` create new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` TODO implement me
`String`	`getIDForStore()`
`Date`	`getModifyStamp()`
`boolean`	`isExpired()`
`boolean`	`isPersistent()`
`boolean`	`isRemoved()`
`void`	`setExpireInMinutes(long nExpire)` enable the expire feature for this entity and set the expire time in minutes from now.
`void`	`setExpireInSeconds(long nExpire)` enable the expire feature for this entity and set the expire time in seconds from now.
`void`	`setModifyStamp()` has to be called by the DB layer in case this entity is created new or updated within the DB back end.
`void`	`setPersistent(boolean bPersistent)` mark the entity as persistent (or not persistent any longer) within the DB back end.
`void`	`setRemoved(boolean bState)`
`String`	`toString()`

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

- Field Detail
  - ATTRIBUTE_NAME_ID
```
public static final String ATTRIBUTE_NAME_ID
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_NAME_EXPIRE
```
public static final String ATTRIBUTE_NAME_EXPIRE
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_NAME_MODIFY_STAMP
```
public static final String ATTRIBUTE_NAME_MODIFY_STAMP
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_NAME_REMOVED
```
public static final String ATTRIBUTE_NAME_REMOVED
```
    See Also:
    
    Constant Field Values
  - COLUMN_NAME_ID
```
public static final String COLUMN_NAME_ID
```
    See Also:
    
    Constant Field Values
  - COLUMN_NAME_EXPIRE
```
public static final String COLUMN_NAME_EXPIRE
```
    See Also:
    
    Constant Field Values
  - COLUMN_NAME_MODIFY_STAMP
```
public static final String COLUMN_NAME_MODIFY_STAMP
```
    See Also:
    
    Constant Field Values
  - COLUMN_NAME_REMOVED
```
public static final String COLUMN_NAME_REMOVED
```
    See Also:
    
    Constant Field Values
  - PreId
```
public transient String PreId
```
    help the DB back end to track the process of generating IDs within error prone transactions. Has not to be used/called from 'outside'. BEFORE a new entity is stored such PreId is calculated and used after storing the entity was successfully. Further it has not to be made persistent - it's a transient property.
  - ExternalId
```
public transient String ExternalId
```
    Sometimes the outside code wish to use it's own ID instead of generating a new one all the time. That's e.g. good for using the same ID in different tables and speed up performance because one ID can be used within several tables as key (where direct access will be possible instead of using queries). Of course such ID has to match the ID-type of this entity. An existing external ID is preferred against PreId ! Further it has not to be made persistent - it's a transient property.
  - Id
```
public String Id
```
  - Expire
```
public Long Expire
```
    Special feature to let entities expire after the specified amount of time. Define the time offset into the future where you wish that those entity should expire automatic. Define nothing (or set it to 'null' explicit) if you don't wish to use that feature. The time to be set here must be in [ms] ... or you use specialized helper methods on this class to set/get those value.
  - ModifyStamp
```
public Date ModifyStamp
```
    Special feature to know when a DB entry was modified last time. Its the time where the last write operation on that entry was done. Our backup solution can rely on that and e.g. backup all new items after a special date.
  - Removed
```
public boolean Removed
```
    Interims feature to know 'removed' items in DB ... If and how we use that information isn't clear at the moment .-)
- Constructor Detail
  - EntityBase
```
public EntityBase()
```
    create new instance.
- Method Detail
  - isPersistent
```
public boolean isPersistent()
                     throws Exception
```
    Returns:
    
    if these entity is already persistent within the DB back end or not.
    
    Throws:
    
    Exception
  - setPersistent
```
public void setPersistent(boolean bPersistent)
                   throws Exception
```
    mark the entity as persistent (or not persistent any longer) within the DB back end. Because those state is known by the DB back end only those method has not to be called from outside and anybody. Let it protected .-)
    
    Parameters:
    
    bPersistent - [IN] the new persistent state.
    
    Throws:
    
    Exception
  - getIDForStore
```
public String getIDForStore()
                     throws Exception
```
    Returns:
    
    the ID to be used for storing this entity. Because we know several ways to get an ID the following order will be defined: a) if an external ID exists it's preferred b) if a new pre-generated ID exists it's used next c) if an ID already exists (because the entity is already stored) it's used last.
    
    Throws:
    
    Exception
  - setExpireInSeconds
```
public void setExpireInSeconds(long nExpire)
                        throws Exception
```
    enable the expire feature for this entity and set the expire time in seconds from now.
    
    Specified by:
    
    setExpireInSeconds in interface IEntity
    
    Parameters:
    
    nExpire - [IN] the time for expire in seconds.
    
    Throws:
    
    Exception
  - setExpireInMinutes
```
public void setExpireInMinutes(long nExpire)
                        throws Exception
```
    enable the expire feature for this entity and set the expire time in minutes from now.
    
    Specified by:
    
    setExpireInMinutes in interface IEntity
    
    Parameters:
    
    nExpire - [IN] the time for expire in minutes.
    
    Throws:
    
    Exception
  - isExpired
```
public boolean isExpired()
                  throws Exception
```
    Returns:
    
    true if entity is expired; false otherwise.
    
    Throws:
    
    Exception
  - setModifyStamp
```
public void setModifyStamp()
                    throws Exception
```
    has to be called by the DB layer in case this entity is created new or updated within the DB back end. It has to be called BEFORE such write operation will be done. We renew our modify-date-time-stamp then ... it will be written to the DB and our backup solution can work with that value.
    
    Throws:
    
    Exception
  - getModifyStamp
```
public Date getModifyStamp()
                    throws Exception
```
    Throws:
    
    Exception
  - setRemoved
```
public void setRemoved(boolean bState)
                throws Exception
```
    Throws:
    
    Exception
  - isRemoved
```
public boolean isRemoved()
                  throws Exception
```
    Throws:
    
    Exception
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    TODO implement me
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EntityBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIBUTE_NAME_ID

ATTRIBUTE_NAME_EXPIRE

ATTRIBUTE_NAME_MODIFY_STAMP

ATTRIBUTE_NAME_REMOVED

COLUMN_NAME_ID

COLUMN_NAME_EXPIRE

COLUMN_NAME_MODIFY_STAMP

COLUMN_NAME_REMOVED

PreId

ExternalId

Id

Expire

ModifyStamp

Removed

Constructor Detail

EntityBase

Method Detail

isPersistent

setPersistent

getIDForStore

setExpireInSeconds

setExpireInMinutes

isExpired

setModifyStamp

getModifyStamp

setRemoved

isRemoved

clone

toString