rs.data.api.dao

Interface GeneralDAO<K extends Serializable,B extends GeneralBO<K>>

Type Parameters:

K - type of primary key

B - type of Business Object

All Known Subinterfaces:

LongDAO<B>, StringDAO<B>

All Known Implementing Classes:

AbstractDAO, AbstractGeneralDAO

public interface GeneralDAO<K extends Serializable,B extends GeneralBO<K>>

Interface for Data Access Objects.

Author:

ralph

Method Summary

Methods

Modifier and Type	Method and Description
void	addDaoListener(DaoListener listener) Adds a DAO event listener.
void	create(B object) Inserts the object into the database if it does not exist.
void	create(B object, boolean setCreationDate) Inserts the object into the database if it does not exist.
void	createObject(Object object) Inserts the object into the database if it does not exist.
void	createObject(Object object, boolean setCreationDate) Creates the object.
void	delete(B object) Deletes the object.
int	deleteAll() Deletes all objects.
int	deleteDefaultAll() Deletes all objects.
void	deleteObject(Object object) Deletes the object.
List<B>	findAll() Returns all domain objects.
List<B>	findAll(int firstResult, int maxResults) Returns a subset of all objects.
B	findById(K id) Find the given object in model.
List<B>	findDefaultAll() Returns domain objects with default criteria.
List<B>	findDefaultAll(int firstResult, int maxResults) Returns domain objects with default criteria.
DaoMaster	getDaoMaster() Returns the DAO master.
int	getDefaultObjectCount() Returns the number of objects with default criteria matched.
DaoFactory	getFactory() Returns the DAO factory.
int	getObjectCount() Returns the number of domain objects.
DaoIterator<B>	iterateAll() Returns all domain objects.
DaoIterator<B>	iterateAll(int firstResult, int maxResults) Returns a subset of all objects
DaoIterator<B>	iterateDefaultAll() Returns domain objects with default criteria.
DaoIterator<B>	iterateDefaultAll(int firstResult, int maxResults) Returns a subset of domain objects with default criteria.
B	newInstance() Create a new domain class instance.
void	removeDaoListener(DaoListener listener) Removes a DAO event listener.
void	save(B object) Saves the object.
void	save(B object, boolean setChangeDate) Saves the object.
void	saveObject(Object object) Saves the object.
void	saveObject(Object object, boolean setChangeDate) Saves the object.
void	setDaoMaster(DaoMaster daoMaster) Sets the DAO master.
void	setFactory(DaoFactory factory) Sets the factory.

Method Detail

getFactory

DaoFactory getFactory()

Returns the DAO factory.

Returns:

the DAO factory this DAO is assigned to

setFactory

void setFactory(DaoFactory factory)

Sets the factory.

Parameters:

factory -

getDaoMaster

DaoMaster getDaoMaster()

Returns the DAO master.

Returns:

the DAO master

setDaoMaster

void setDaoMaster(DaoMaster daoMaster)

Sets the DAO master.

Parameters:

daoMaster - the master

newInstance

B newInstance()

Create a new domain class instance. This method will set the creation date.

Returns:

new instance

createObject

void createObject(Object object)

Inserts the object into the database if it does not exist. This method will set the creation date.

Parameters:

object - domain class instance

createObject

void createObject(Object object,
                boolean setCreationDate)

Creates the object.

Parameters:

object - object to be saved

setCreationDate - whether creationDate will be set

See Also:

create(GeneralBO, boolean)

create

void create(B object)

Inserts the object into the database if it does not exist. This method will set the creation date.

Parameters:

object - domain class instance

create

void create(B object,
          boolean setCreationDate)

Inserts the object into the database if it does not exist.

Parameters:

object - domain class instance

setCreationDate - whether creation date shall be set

getObjectCount

int getObjectCount()

Returns the number of domain objects.

Returns:

number of objects.

getDefaultObjectCount

int getDefaultObjectCount()

Returns the number of objects with default criteria matched. This method shall be used if you want to count only non-deleted objects.

Returns:

number of objects

findById

B findById(K id)

Find the given object in model.

Parameters:

id - id of object

Returns:

object

findAll

List<B> findAll()

Returns all domain objects.

Returns:

list of all objects

findAll

List<B> findAll(int firstResult,
              int maxResults)

Returns a subset of all objects.

Parameters:

firstResult - index of first result

maxResults - maximum number of results to return

Returns:

list of objects

findDefaultAll

List<B> findDefaultAll()

Returns domain objects with default criteria. A default criteria could hide objects not needed regulary (e.g. deleted objects)

Returns:

list of all objects

findDefaultAll

List<B> findDefaultAll(int firstResult,
                     int maxResults)

Returns domain objects with default criteria. A default criteria could hide objects not needed regulary (e.g. deleted objects)

Returns:

list of all objects

iterateAll

DaoIterator<B> iterateAll()

Returns all domain objects.

Returns:

list of all objects

iterateAll

DaoIterator<B> iterateAll(int firstResult,
                        int maxResults)

Returns a subset of all objects

Parameters:

firstResult - index of first result

maxResults - maximum number of results to return

Returns:

iterator of BO

iterateDefaultAll

DaoIterator<B> iterateDefaultAll()

Returns domain objects with default criteria. A default criteria could hide objects not needed regulary (e.g. deleted objects)

Returns:

list of all objects

iterateDefaultAll

DaoIterator<B> iterateDefaultAll(int firstResult,
                               int maxResults)

Returns a subset of domain objects with default criteria. A default criteria could hide objects not needed regulary (e.g. deleted objects)

Parameters:

firstResult - index of first result

maxResults - maximum number of results to return

Returns:

list of all objects

saveObject

void saveObject(Object object)

Saves the object. This method assumes that the object already exists. Also, this method will set the change date.

Parameters:

object - object to be saved

saveObject

void saveObject(Object object,
              boolean setChangeDate)

Saves the object. This method assumes that the object already exists.

Parameters:

object - object to be saved

setChangeDate - whether changeDate will be set

save

void save(B object)

Saves the object. This method assumes that the object already exists. Also, this method will set the change date.

Parameters:

object - object to be saved

save

void save(B object,
        boolean setChangeDate)

Saves the object. This method assumes that the object already exists.

Parameters:

object - object to be saved

setChangeDate - whether changeDate will be set

deleteObject

void deleteObject(Object object)

Deletes the object.

Parameters:

object - object to be saved

delete

void delete(B object)

Deletes the object. This method assumes that the object existed before.

Parameters:

object - object to be deleted.

deleteAll

int deleteAll()

Deletes all objects.

Returns:

number of object deleted

deleteDefaultAll

int deleteDefaultAll()

Deletes all objects.

Returns:

number of object deleted

addDaoListener

void addDaoListener(DaoListener listener)

Adds a DAO event listener.

Parameters:

listener - listener

removeDaoListener

void removeDaoListener(DaoListener listener)

Removes a DAO event listener.

Parameters:

listener - listener