org.exolab.castor.jdo
Interface DataObjects

All Superinterfaces:

javax.naming.Referenceable, java.io.Serializable

All Known Implementing Classes:

JDO

public interface DataObjects

extends javax.naming.Referenceable, java.io.Serializable

A factory for Database connections. This object is used to define the database to use and to open up database connections using the getDatabase() method.

This object can be serialized or bound to a JNDI namespace.

Version:

$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:07 $

Author:

Assaf Arkin

Method Summary

Database	getDatabase() Opens and returns a connection to the database.
java.lang.String	getDescription() Returns the description of this database.
void	setDescription(java.lang.String description) Sets the description of this database.

Methods inherited from interface javax.naming.Referenceable

getReference

Method Detail

getDatabase

public Database getDatabase()
                     throws DatabaseNotFoundException,
                            PersistenceException

Opens and returns a connection to the database.

Returns:

An open connection to the database

Throws:

DatabaseNotFoundException - Attempted to open a database that does not exist

PersistenceException - Database access failed

setDescription

public void setDescription(java.lang.String description)

Sets the description of this database.

Parameters:

description - The description of this database

getDescription

public java.lang.String getDescription()

Returns the description of this database.

Returns:

The description of this database