com.buckosoft.PicMan.db

Interface RootsDao

All Known Implementing Classes:

RootsDaoJdbc

public interface RootsDao

Dao interface for the Roots.
Note: The Roots are cached and any changes made external to the program will not be properly picked up.

Since:

2006/09/30

Author:

Dick Balaska

See Also:

RootsDao.java

Method Summary

Modifier and Type	Method and Description
void	addRoot(Root root) Add this Root to the database.
void	deleteRoot(Root root) Delete this Root from the database.
java.util.List<Root>	getActiveRoots() Get a List of Roots that the user has NOT marked as inactive.
java.util.List<Root>	getInactiveRoots() Get a List of Roots that the user has marked as inactive.
Root	getRoot(int rid) Fetch the Root that matches this Root ID.
Root	getRoot(java.lang.String rootName) Get the Root that matches this name.
int	getRootCount() Fetch the number of Roots in the database.
java.util.List<Root>	getRoots() Fetch a List of all Roots in the database.
void	setRoots(java.util.List<Root> roots) Set the Roots in the database to be this list.
void	storeRoot(Root root) Update an existing root in the database.

Method Detail

getRootCount

int getRootCount()
          throws DataAccessException

Fetch the number of Roots in the database.

Returns:

The count.

Throws:

DataAccessException - It broke.

getRoots

java.util.List<Root> getRoots()
                       throws DataAccessException

Fetch a List of all Roots in the database.

Returns:

The List of Roots.

Throws:

DataAccessException - broken.

getRoot

Root getRoot(int rid)
      throws DataAccessException

Fetch the Root that matches this Root ID.

Parameters:

rid - The Root ID to query.

Returns:

The Root that matches this Root ID or null if not found.

Throws:

DataAccessException - Didn't happen.

getRoot

Root getRoot(java.lang.String rootName)
      throws DataAccessException

Get the Root that matches this name.

Parameters:

rootName - The name of the Root to query.

Returns:

The Root that matches this name or null if not found.

Throws:

DataAccessException - needs fixin'.

setRoots

void setRoots(java.util.List<Root> roots)
       throws DataAccessException

Set the Roots in the database to be this list.
Why you would want to do this, is beyond me. But, here it is...

Parameters:

roots - The Roots to store.

Throws:

DataAccessException - Help me Lawdy!

addRoot

void addRoot(Root root)
      throws DataAccessException

Add this Root to the database.

Parameters:

root - The Root to store.

Throws:

DataAccessException - not ... gonna ... make ... it.

deleteRoot

void deleteRoot(Root root)
         throws DataAccessException

Delete this Root from the database.

Parameters:

root - The Root to delete.

Throws:

DataAccessException - died.

getActiveRoots

java.util.List<Root> getActiveRoots()
                             throws DataAccessException

Get a List of Roots that the user has NOT marked as inactive.

Returns:

The List of Roots.

Throws:

DataAccessException - no joy.

getInactiveRoots

java.util.List<Root> getInactiveRoots()
                               throws DataAccessException

Get a List of Roots that the user has marked as inactive.

Returns:

The List of Roots.

Throws:

DataAccessException - Sorry.

storeRoot

void storeRoot(Root root)
        throws DataAccessException

Update an existing root in the database.

Parameters:

root - The root to store

Throws:

DataAccessException