Package com.odi

Interface Summary
IPersistent Every persistence-capable class must implement the IPersistent interface or be a subclass of a class that implements it.
IPersistentHooks The IPersistentHooks interface declares serveral "hook" methods which allow PSE/PSE Pro to notify a class instance of calls to certain methods defined in the IPersistent interface which are normally defined by the class file post-processor.
ObjectStoreConstants The ObjectStoreConstants interface defines constants that are used throughout the PSE/PSE Pro API.
 

Class Summary
ClassInfo ClassInfo is an abstract class that PSE/PSE Pro uses to manage the schema information for persistence-capable classes.
Cluster PSE/PSE Pro uses the Cluster class to represent a cluster in a segment.
Database The Database class is an abstract class that represents a database.
DatabaseRootEnumeration The DatabaseRootEnumeration class defines the operations for iterating over the names of the database roots in a database.
DatabaseSegmentEnumeration The DatabaseSegmentEnumeration class defines the operations for enumerating the segments in a database.
ExternalReference An object of the ExternalReference class is a reference to a particular persistent object.
Field The Field class represents a Java field in a persistent object.
GenericObject The GenericObject class is an abstract class that PSE/PSE Pro uses to transfer data between a database and a Java application or applet.
LockTimeoutBlocker Describes another client that was involved in a concurrency conflict.
ObjectStore The ObjectStore class defines system-level operations that are not specific to any database.
ObjectStorePersistentTypeSummary The com.odi.ObjectStorePersistentTypeSummary class is provided for installing the OSJI persistent types in the database schema.
Persistent Deprecated. 
PersistentTypeSummary The com.odi.PersistentTypeSummary class allows the types used by a Java application or library to be identified.
Placement The Placement class is the abstract superclass of classes that specify where an object should be migrated or allocated.
Segment PSE/PSE Pro uses the Segment class to represent a segment in a database.
Session A session allows the use of the PSE/PSE Pro API.
Transaction PSE/PSE Pro uses the Transaction class to represent a logical unit of work.
UnregisteredType PSE/PSE Pro provides the UnregisteredType class to represent types in your database that are not registered with PSE/PSE Pro.
 

Exception Summary
AbortException A superclass of all exceptions that abort the current transaction when thrown.
AccessViolationException Thrown when an access permission problem interferes with opening or creating a database.
AddressSpaceFullException This exception is thrown when ObjectStore runs out of address space.
BadArrayDimensionsException Thrown when an attempt is made to store an array with dimensions greater than the maximum supported.
BrokenServerConnectionException Thrown when the connection to an ObjectStore Server is broken.
ClassNotRegisteredException Thrown whenever an attempt is made to access a class that is not known to PSE/PSE Pro because the class was not registered with a call to the ClassInfo.register() method.
ClusterException A superclass of all exceptions related to clusters, and the class of exception thrown for certain PSE/PSE Pro version restrictions.
ClusterNotFoundException Thrown when an entry point is called that attempts to use a cluster that has never been created or has been destroyed.
DatabaseAlreadyExistsException Thrown when an attempt is made to create a database that already exists.
DatabaseException A superclass of all exceptions related to databases and the class of exception thrown for miscellaneous database problems that do not need to be handled programmatically.
DatabaseFormatException Thrown when an attempt is made to open a database that is either broken or cannot be recognized as a database.
DatabaseLockedException Thrown when attempting to open a database that is locked by another process and NON_BLOCKING mode was specified in the open mode argument to open.
DatabaseNeedsRecoveryException Thrown when attempting to open a database that needs recovery.
DatabaseNotAffiliatedException Thrown when there is an attempt to store in a database a reference to an object in another database that is not affiliated with this database.
DatabaseNotFoundException Thrown when an attempt is made to open a database and that database is not found.
DatabaseNotOpenException Thrown when an attempt is made to call an entrypoint with a closed database that expects an open database.
DatabaseOpenException Thrown when an attempt is made to call an entrypoint with an open database that expects a closed database.
DatabaseRootAlreadyExistsException Thrown when an attempt is made to create a root and that root already exists.
DatabaseRootNotFoundException Thrown when an attempt is made to call an entry point and that entry point requires an existing database root that is not found.
DatabaseUpgradeException Thrown when an attempt is made to open a database and that is not at the correct version level.
DeadlockException Thrown when a call to an API entry point produces a deadlock.
FatalApplicationException Thrown when the behavior of the application or factors in the application environment produce problems that require PSE/PSE Pro to be shut down.
FatalException A superclass of all exceptions that shut down PSE/PSE Pro when they are thrown.
FatalInternalException Thrown when a condition that is not the result of a correctable user action results in an internal inconsistency that requires a shutdown.
IncompatibleClassException Thrown when an attempt is made to use a persistent object whose persistent schema does not match its current transient class definition.
IncompatibleOpenModeException Thrown when an attempt is made to open a database that is already open, but with an incompatible open mode.
InvalidExportIdException Thrown when an attempt is made to export an object with an export id in use
InvalidSummaryException Thrown whenever a PersistentTypeSummary is found to be missing or uninstantiable.
LockTimeoutException Thrown when a call to an API entrypoint produces a concurrency conflict that cannot be resolved within the specified timeout.
LockWaitInterruptedException Thrown when a thread is interrupted while it is waiting for a lock.
MvccIncoherentException Thrown when a call to an API entry point produces a coherence conflict during transaction in a set of files opened for MULTI_DB_MVCC.
NoSessionException Exception thrown when a method requires the calling thread to be associated with a session but the thread is not, or a method that requires an active session is called on a session object for a terminated session.
NoTransactionInProgressException Thrown when an attempt is made to call an entrypoint that requires an open transaction and there is no open transaction.
ObjectAlreadyExportedException Thrown when an attempt is made to export an object that is already exported.
ObjectException A superclass of all exceptions related to persistent objects, and the class of exception thrown for PSE/PSE Pro version restrictions.
ObjectNotExportedException Thrown when an attempt is made to call an API entry point on a local object and the entry point requires an exported object.
ObjectNotFoundException Thrown when an operation tries to use an object that does not exist.
ObjectNotPersistenceCapableException Thrown when an attempt is made to call an API entrypoint on an object that is not persistence-capable when the entrypoint requires a persistence-capable object.
ObjectNotPersistentException Thrown when an operation is attempted on a transient object that is only permitted on a persistent object.
ObjectStoreException A superclass of all PSE/PSE Pro exceptions, the direct superclass of exceptions related to the ObjectStore class, and the class used for ObjectStore class exceptions that are not required to be separately caught by applications.
ReferencedObjectNotFoundException Thrown when an operation tries to use an object but that object references another object which does not exist and that referenced object is needed for the operation to complete.
RestartableAbortException An abstract superclass of all exceptions that abort the current transaction but for which it makes sense to just retry the transaction.
SchemaEvolutionException A superclass of all exceptions related to schema evolution.
SchemaException A superclass of all exceptions related to class information provided by superclasses of the ClassInfo class and related facilities.
SegmentException A superclass of all exceptions related to segments, and the class of exception thrown for certain PSE/PSE Pro version restrictions.
SegmentNotFoundException Thrown when an entry point is called that attempts to use a segment that has never been created or has been destroyed.
ServerRefusedConnectionException Thrown when an attempt to connect to an ObjectStore Server fails because the Server is not available.
ServerRestartedException Thrown when an ObjectStore Server has been restarted.
SessionException A super class of all session related exceptions.
StaleEnumeratorException Thrown when an enumeration becomes stale and the information it provides has become unusable.
StaleIteratorException Thrown when an iterator becomes stale and the information it provides has become unusable.
TransactionException A superclass of all exceptions related to transactions.
TransactionInProgressException Thrown when the application tries to use an entrypoint inside a transaction when that entrypoint can be used only outside a transaction.
UnexportedObjectsBecameStaleException Thrown when retained, unexported objects in a segment have been made stale.
UpdateReadOnlyException Thrown when an attempt is made to call an entry point to modify a database either during a read-only transaction or for a database that has been opened for read-only.
WrongSessionException Exception thrown when the session associated with or implied by an object referenced in a method is different from the session the calling thread is joined to.
 



Copyright 2005 Progress Software Corporation. All rights reserved.