Content Engine Java API: CmDatabaseConnection

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, java.io.Serializable
```
public interface CmDatabaseConnection
extends IndependentlyPersistableObject
```
Contains database connection information for object stores, event export stores, and isolated regions. This administrative object is used to define the XA and non-XA data source pair that provides the JDBC connection to the database.
CmDatabaseConnection can be used to configure database connection sharing, allowing you to use a single XA and non-XA data source pair for multiple object stores, event export stores, and isolated regions residing in the same database. To configure database connection sharing, set the same CmDatabaseConnection object on all objects that will share the same database. Whenever possible, configure database connection sharing. Set the same CmDatabaseConnection object on all objects that will share the same database.
You can change a CmDatabaseConnection object on an object store, isolated region, or event export store if and only if the new database connection object points to the same database, or a copy of that database. Deletion of a CmDatabaseConnection object is prevented if referenced by any object store, event export store, or isolated region.

You can have multiple CmDatabaseConnection objects contained within a domain. Each CmDatabaseConnection object must reference unique data sources defined in the application server. You can change the data source values as long as they do not duplicate the data source values of another CmDatabaseConnection object. In addition, the new data source values must point to the same database or a copy of the database for all objects that reference the ICmDatabaseConnection object.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: GenericObject

See Also:
ObjectStore, IsolatedRegion, CmEventExportStore

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`get_Creator()` Returns the value of the Creator property.
`DatabaseType`	`get_DatabaseType()` Returns the value of the DatabaseType property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`java.util.Date`	`get_DateLastModified()` Returns the value of the DateLastModified property.
`java.lang.String`	`get_DescriptiveText()` Returns the value of the DescriptiveText property.
`java.lang.String`	`get_DisplayName()` Returns the value of the DisplayName property.
`CmEventExportStoreSet`	`get_EventExportStores()` Returns the value of the EventExportStores property.
`Id`	`get_Id()` Returns the value of the Id property.
`IsolatedRegionSet`	`get_IsolatedRegions()` Returns the value of the IsolatedRegions property.
`java.lang.String`	`get_JNDIDataSource()` Returns the value of the JNDIDataSource property.
`java.lang.String`	`get_JNDIXADataSource()` Returns the value of the JNDIXADataSource property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`ObjectStoreSet`	`get_ObjectStores()` Returns the value of the ObjectStores property.
`Site`	`get_Site()` Returns the value of the Site property.
`void`	`set_Creator(java.lang.String value)` Sets the value of the Creator property.
`void`	`set_DateCreated(java.util.Date value)` Sets the value of the DateCreated property.
`void`	`set_DescriptiveText(java.lang.String value)` Sets the value of the DescriptiveText property.
`void`	`set_DisplayName(java.lang.String value)` Sets the value of the DisplayName property.
`void`	`set_JNDIDataSource(java.lang.String value)` Sets the value of the JNDIDataSource property.
`void`	`set_JNDIXADataSource(java.lang.String value)` Sets the value of the JNDIXADataSource property.
`void`	`set_Site(Site value)` Sets the value of the Site property.

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_Site
```
Site get_Site()
```
    Returns the value of the Site property. For more information, see Site Property.
  - set_Site
```
void set_Site(Site value)
```
    Sets the value of the Site property. For more information, see Site Property.
  - get_DisplayName
```
java.lang.String get_DisplayName()
```
    Returns the value of the DisplayName property. For more information, see DisplayName Property.
  - set_DisplayName
```
void set_DisplayName(java.lang.String value)
```
    Sets the value of the DisplayName property. For more information, see DisplayName Property.
  - get_DescriptiveText
```
java.lang.String get_DescriptiveText()
```
    Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - set_DescriptiveText
```
void set_DescriptiveText(java.lang.String value)
```
    Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - get_JNDIDataSource
```
java.lang.String get_JNDIDataSource()
```
    Returns the value of the JNDIDataSource property. For more information, see JNDIDataSource Property.
  - set_JNDIDataSource
```
void set_JNDIDataSource(java.lang.String value)
```
    Sets the value of the JNDIDataSource property. For more information, see JNDIDataSource Property.
  - get_JNDIXADataSource
```
java.lang.String get_JNDIXADataSource()
```
    Returns the value of the JNDIXADataSource property. For more information, see JNDIXADataSource Property.
  - set_JNDIXADataSource
```
void set_JNDIXADataSource(java.lang.String value)
```
    Sets the value of the JNDIXADataSource property. For more information, see JNDIXADataSource Property.
  - get_DatabaseType
```
DatabaseType get_DatabaseType()
```
    Returns the value of the DatabaseType property. For more information, see DatabaseType Property.
  - get_ObjectStores
```
ObjectStoreSet get_ObjectStores()
```
    Returns the value of the ObjectStores property. For more information, see ObjectStores Property.
  - get_IsolatedRegions
```
IsolatedRegionSet get_IsolatedRegions()
```
    Returns the value of the IsolatedRegions property. For more information, see IsolatedRegions Property.
  - get_EventExportStores
```
CmEventExportStoreSet get_EventExportStores()
```
    Returns the value of the EventExportStores property. For more information, see EventExportStores Property.

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

Methods inherited from interface com.filenet.api.core.IndependentObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

get_DateLastModified

get_Id

get_Site

set_Site

get_DisplayName

set_DisplayName

get_DescriptiveText

set_DescriptiveText

get_JNDIDataSource

set_JNDIDataSource

get_JNDIXADataSource

set_JNDIXADataSource

get_DatabaseType

get_ObjectStores

get_IsolatedRegions

get_EventExportStores