com.ibm.mm.sdk.common

Interface dkDatastore

All Superinterfaces:

dkQueryEvaluator, dkQueryManager

All Known Subinterfaces:

dkDatastoreIntICM

All Known Implementing Classes:

DKDatastoreICM

public interface dkDatastore
extends dkQueryManager

Core interface for CM8 datastore operations.

This interface provides the fundamental operations for connecting to and managing a CM8 datastore, including connection management, object lifecycle operations, and entity discovery. It extends dkQueryManager to provide query capabilities.

Implementations of this interface typically wrap underlying content management systems (such as FileNet P8) and provide a CM8-compatible API layer.

See Also:

dkQueryManager, DKDatastoreICM

Method Summary

Modifier and Type	Method and Description
void	connect(java.lang.String datastore_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string) Establishes a connection to the datastore.
java.lang.String	datastoreName() Returns the name of the currently connected datastore.
void	deleteObject(dkDataObject ddo) Deletes a data object from the datastore.
void	deleteObject(dkDataObject ddo, int option) Deletes a data object from the datastore with the specified options.
void	destroy() Destroys the datastore connection and releases all resources.
void	disconnect() Disconnects from the datastore and releases all associated resources.
dkCollection	listEntities() Lists all entity types (class definitions) available in the datastore.

Methods inherited from interface com.ibm.mm.sdk.common.dkQueryManager

createQuery

Methods inherited from interface com.ibm.mm.sdk.common.dkQueryEvaluator

evaluate

Method Detail

connect

void connect(java.lang.String datastore_name,
             java.lang.String user_name,
             java.lang.String authentication,
             java.lang.String connect_string)
      throws DKException,
             java.lang.Exception

Establishes a connection to the datastore.

This method authenticates the user and establishes a session with the specified datastore. The connection must be established before any other datastore operations can be performed.

Parameters:

datastore_name - the name of the datastore to connect to

user_name - the username for authentication

authentication - the password or authentication credentials

connect_string - additional connection parameters (implementation-specific)

Throws:

DKException - if the connection fails due to invalid credentials or datastore errors

java.lang.Exception - if an unexpected error occurs during connection

disconnect

void disconnect()
         throws DKException,
                java.lang.Exception

Disconnects from the datastore and releases all associated resources.

After calling this method, the datastore connection is closed and no further operations can be performed until connect(java.lang.String, java.lang.String, java.lang.String, java.lang.String) is called again.

Throws:

DKException - if the disconnection fails

java.lang.Exception - if an unexpected error occurs during disconnection

datastoreName

java.lang.String datastoreName()
                        throws java.lang.Exception

Returns the name of the currently connected datastore.

Returns:

the datastore name, or null if not connected

Throws:

java.lang.Exception - if an error occurs retrieving the datastore name

destroy

void destroy()
      throws DKException,
             java.lang.Exception

Destroys the datastore connection and releases all resources.

This method performs cleanup operations and should be called when the datastore is no longer needed. After calling this method, the datastore instance should not be used.

Throws:

DKException - if the destroy operation fails

java.lang.Exception - if an unexpected error occurs during destruction

deleteObject

void deleteObject(dkDataObject ddo)
           throws DKException,
                  java.lang.Exception

Deletes a data object from the datastore.

This method permanently removes the specified object from the datastore. The operation cannot be undone.

Parameters:

ddo - the data object to delete

Throws:

DKException - if the delete operation fails

java.lang.Exception - if an unexpected error occurs during deletion

deleteObject

void deleteObject(dkDataObject ddo,
                  int option)
           throws DKException,
                  java.lang.Exception

Deletes a data object from the datastore with the specified options.

This method permanently removes the specified object from the datastore using the provided deletion options.

Parameters:

ddo - the data object to delete

option - deletion options (implementation-specific)

Throws:

DKException - if the delete operation fails

java.lang.Exception - if an unexpected error occurs during deletion

listEntities

dkCollection listEntities()
                   throws DKException,
                          java.lang.Exception

Lists all entity types (class definitions) available in the datastore.

This method returns a collection of entity definitions that describe the available document and folder types in the datastore. Each entity definition includes metadata such as the entity name, type, and attributes.

Returns:

a collection of entity definitions

Throws:

DKException - if the list operation fails

java.lang.Exception - if an unexpected error occurs