net.as_development.asdk.api.db

Interface IDBSchema

All Known Implementing Classes:

DB

public interface IDBSchema

Can be used to create needed DB structures.

Method Summary

Modifier and Type	Method and Description
<TEntity extends IEntity> void	createEntitySchema(Class<TEntity> aType) create necessary structures inside DB for specified entity type.
<TEntity extends IEntity> void	removeEntitySchema(Class<TEntity> aType) remove all data within DB back end related to the specified entity.

Method Detail

createEntitySchema

<TEntity extends IEntity> void createEntitySchema(Class<TEntity> aType)
                                           throws Exception

create necessary structures inside DB for specified entity type. Means: it will create the table inside data base backend. It's separated because we do not wish to create such structures on demand if an entity should be made persistent. YOU should decide when it's time to do so ..

Parameters:

aType - [IN] describe the entity type.

Throws:

Exception - is creating the schema was not successfully.

removeEntitySchema

<TEntity extends IEntity> void removeEntitySchema(Class<TEntity> aType)
                                           throws Exception

remove all data within DB back end related to the specified entity.

Parameters:

aType - [IN] describe the entity type.

Throws:

Exception - if operation failed and entity data couldn't be removed. Note It throws NO exception in case entity is unknown within these DB.