Domain

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, InstantiatingScope, Scope, java.io.Serializable
```
public interface Domain
extends InstantiatingScope, IndependentlyPersistableObject
```
Represents a collection of resources and services sharing the same Global Configuration Database (GCD). The GCD defines a common set of attributes that control functional characteristics of the collection of resources and services for this domain. The GCD defines domain resources, such as sites (and their related virtual servers and server instances), object store databases, full-text index areas, file storage areas, content cache areas, add-ons, marking sets, and so on. The FileNet P8 domain is also associated with one or more security realms for authorizing users.
Although you can programmatically create a domain, it is not typical to do so. (For a code sample, see Creating a Domain Object.) In a more typical scenario, you can retrieve a persisted Domain object by calling getInstance or fetchInstance on the Factory.Domain class. You can also call ObjectStore.getDomain(), which returns an object-valued Domain property.

Metadata

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AddOnSet`	`get_AddOns()` Returns the value of the AddOns property.
`ContentCacheAreaSet`	`get_ContentCacheAreas()` Returns the value of the ContentCacheAreas property.
`CmCredentialsManagerSet`	`get_CredentialsManagers()` A collection of all the Credentials Manager instances defined in the domain.
`CmDatabaseConnectionSet`	`get_DatabaseConnections()` Returns the value of the DatabaseConnections property.
`Site`	`get_DefaultSite()` Returns the value of the DefaultSite property.
`DirectoryConfigurationList`	`get_DirectoryConfigurations()` Returns the value of the DirectoryConfigurations property.
`java.lang.String`	`get_DocumentationURL()` Returns the value of the DocumentationURL property.
`DomainType`	`get_DomainType()` Returns the value of the DomainType property.
`CmElasticSearchClusterSet`	`get_ElasticSearchClusters()` A collection of the Elastic Search clusters defined for the domain,
`CmEventExportStoreSet`	`get_EventExportStores()` Returns the value of the EventExportStores property.
`ExternalRepositorySet`	`get_ExternalRepositories()` Returns the value of the ExternalRepositories property.
`FixedContentDeviceSet`	`get_FixedContentDevices()` Returns the value of the FixedContentDevices property.
`java.lang.Integer`	`get_GCDRevisionNumber()` Returns the value of the GCDRevisionNumber 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_KeyServiceConnection()` Specifies the parameters for connecting to the external service managing cryptographic keys on behalf on the Content Platform Engine.
`java.lang.String`	`get_KeyServiceType()` Specifies the type of the external service managing cryptographic keys on behalf on the Content Platform Engine.
`java.lang.Boolean`	`get_LocalGroupsEnabled()` Enables use of local groups for this domain.
`MarkingSetSet`	`get_MarkingSets()` Returns the value of the MarkingSets property.
`java.lang.String`	`get_Name()` Returns the value of the Name property.
`ObjectStoreSet`	`get_ObjectStores()` Returns the value of the ObjectStores property.
`java.lang.String`	`get_ObjectStoreSchemaDB2()` Returns the value of the ObjectStoreSchemaDB2 property.
`java.lang.String`	`get_ObjectStoreSchemaMSSQL()` Returns the value of the ObjectStoreSchemaMSSQL property.
`java.lang.String`	`get_ObjectStoreSchemaMySQL()` Returns the value of the ObjectStoreSchemaMySQL property.
`java.lang.String`	`get_ObjectStoreSchemaOracle()` Returns the value of the ObjectStoreSchemaOracle property.
`java.lang.String`	`get_ObjectStoreSchemaPostgreSQL()` Returns the value of the ObjectStoreSchemaPostgreSQL property.
`PEConnectionPointSet`	`get_PEConnectionPoints()` Returns the value of the PEConnectionPoints property.
`AccessPermissionDescriptionList`	`get_PermissionDescriptions()` Returns the value of the PermissionDescriptions property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`ReplicationGroupSet`	`get_ReplicationGroups()` Returns the value of the ReplicationGroups property.
`SiteSet`	`get_Sites()` Returns the value of the Sites property.
`SubsystemConfigurationList`	`get_SubsystemConfigurations()` Returns the value of the SubsystemConfigurations property.
`java.lang.String`	`get_SystemUserName()` The name for the system user account.
`byte[]`	`get_SystemUserPassword()` The password for the system user account.
`CmTextSearchAffinityGroupSet`	`get_TextSearchAffinityGroups()` Returns the value of the TextSearchAffinityGroups property.
`CmTextSearchServerSet`	`get_TextSearchServers()` Returns the value of the TextSearchServers property.
`UpgradeStatus`	`get_UpgradeStatus()` Specifies the upgrade status of the domain.
`void`	`set_DefaultSite(Site value)` Sets the value of the DefaultSite property.
`void`	`set_DirectoryConfigurations(DirectoryConfigurationList value)` Sets the value of the DirectoryConfigurations property.
`void`	`set_DomainType(DomainType value)` Sets the value of the DomainType property.
`void`	`set_KeyServiceConnection(java.lang.String value)` Specifies the parameters for connecting to the external service managing cryptographic keys on behalf on the Content Platform Engine.
`void`	`set_KeyServiceType(java.lang.String value)` Specifies the type of the external service managing cryptographic keys on behalf on the Content Platform Engine.
`void`	`set_LocalGroupsEnabled(java.lang.Boolean value)` Enables use of local groups for this domain.
`void`	`set_Name(java.lang.String value)` Sets the value of the Name property.
`void`	`set_Permissions(AccessPermissionList value)` Sets the value of the Permissions property.
`void`	`set_SubsystemConfigurations(SubsystemConfigurationList value)` Sets the value of the SubsystemConfigurations property.
`void`	`set_SystemUserName(java.lang.String value)` The name for the system user account.
`void`	`set_SystemUserPassword(byte[] value)` The password for the system user account.
`void`	`set_UpgradeStatus(UpgradeStatus value)` Specifies the upgrade status of the domain.

Methods inherited from interface com.filenet.api.core.InstantiatingScope
createObject, createObject, fetchObject, fetchObject, getObject, getObject

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_Name
```
java.lang.String get_Name()
```
    Returns the value of the Name property. For more information, see Name Property.
  - set_Name
```
void set_Name(java.lang.String value)
```
    Sets the value of the Name property. For more information, see Name Property.
  - get_ObjectStores
```
ObjectStoreSet get_ObjectStores()
```
    Returns the value of the ObjectStores property. For more information, see ObjectStores Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_Permissions
```
AccessPermissionList get_Permissions()
```
    Returns the value of the Permissions property. For more information, see Permissions Property.
  - set_Permissions
```
void set_Permissions(AccessPermissionList value)
```
    Sets the value of the Permissions property. For more information, see Permissions Property.
  - get_PermissionDescriptions
```
AccessPermissionDescriptionList get_PermissionDescriptions()
```
    Returns the value of the PermissionDescriptions property. For more information, see PermissionDescriptions Property.
  - get_MarkingSets
```
MarkingSetSet get_MarkingSets()
```
    Returns the value of the MarkingSets property. For more information, see MarkingSets Property.
  - get_AddOns
```
AddOnSet get_AddOns()
```
    Returns the value of the AddOns property. For more information, see AddOns Property.
  - get_DefaultSite
```
Site get_DefaultSite()
```
    Returns the value of the DefaultSite property. For more information, see DefaultSite Property.
  - set_DefaultSite
```
void set_DefaultSite(Site value)
```
    Sets the value of the DefaultSite property. For more information, see DefaultSite Property.
  - get_Sites
```
SiteSet get_Sites()
```
    Returns the value of the Sites property. For more information, see Sites Property.
  - get_FixedContentDevices
```
FixedContentDeviceSet get_FixedContentDevices()
```
    Returns the value of the FixedContentDevices property. For more information, see FixedContentDevices Property.
  - get_SubsystemConfigurations
```
SubsystemConfigurationList get_SubsystemConfigurations()
```
    Returns the value of the SubsystemConfigurations property. For more information, see SubsystemConfigurations Property.
  - set_SubsystemConfigurations
```
void set_SubsystemConfigurations(SubsystemConfigurationList value)
```
    Sets the value of the SubsystemConfigurations property. For more information, see SubsystemConfigurations Property.
  - get_ContentCacheAreas
```
ContentCacheAreaSet get_ContentCacheAreas()
```
    Returns the value of the ContentCacheAreas property. For more information, see ContentCacheAreas Property.
  - get_IsolatedRegions
```
IsolatedRegionSet get_IsolatedRegions()
```
    Returns the value of the IsolatedRegions property. For more information, see IsolatedRegions Property.
  - get_PEConnectionPoints
```
PEConnectionPointSet get_PEConnectionPoints()
```
    Returns the value of the PEConnectionPoints property. For more information, see PEConnectionPoints Property.
  - get_DirectoryConfigurations
```
DirectoryConfigurationList get_DirectoryConfigurations()
```
    Returns the value of the DirectoryConfigurations property. For more information, see DirectoryConfigurations Property.
  - set_DirectoryConfigurations
```
void set_DirectoryConfigurations(DirectoryConfigurationList value)
```
    Sets the value of the DirectoryConfigurations property. For more information, see DirectoryConfigurations Property.
  - get_ExternalRepositories
```
ExternalRepositorySet get_ExternalRepositories()
```
    Returns the value of the ExternalRepositories property. For more information, see ExternalRepositories Property.
  - get_ReplicationGroups
```
ReplicationGroupSet get_ReplicationGroups()
```
    Returns the value of the ReplicationGroups property. For more information, see ReplicationGroups Property.
  - get_ObjectStoreSchemaDB2
```
java.lang.String get_ObjectStoreSchemaDB2()
```
    Returns the value of the ObjectStoreSchemaDB2 property. For more information, see ObjectStoreSchemaDB2 Property.
  - get_ObjectStoreSchemaMSSQL
```
java.lang.String get_ObjectStoreSchemaMSSQL()
```
    Returns the value of the ObjectStoreSchemaMSSQL property. For more information, see ObjectStoreSchemaMSSQL Property.
  - get_ObjectStoreSchemaOracle
```
java.lang.String get_ObjectStoreSchemaOracle()
```
    Returns the value of the ObjectStoreSchemaOracle property. For more information, see ObjectStoreSchemaOracle Property.
  - get_ObjectStoreSchemaPostgreSQL
```
java.lang.String get_ObjectStoreSchemaPostgreSQL()
```
    Returns the value of the ObjectStoreSchemaPostgreSQL property. For more information, see ObjectStoreSchemaPostgreSQL Property.
  - get_ObjectStoreSchemaMySQL
```
java.lang.String get_ObjectStoreSchemaMySQL()
```
    Returns the value of the ObjectStoreSchemaMySQL property. For more information, see ObjectStoreSchemaMySQL Property.
  - get_TextSearchServers
```
CmTextSearchServerSet get_TextSearchServers()
```
    Returns the value of the TextSearchServers property. For more information, see TextSearchServers Property.
  - get_DatabaseConnections
```
CmDatabaseConnectionSet get_DatabaseConnections()
```
    Returns the value of the DatabaseConnections property. For more information, see DatabaseConnections Property.
  - get_DocumentationURL
```
java.lang.String get_DocumentationURL()
```
    Returns the value of the DocumentationURL property. For more information, see DocumentationURL Property.
  - get_GCDRevisionNumber
```
java.lang.Integer get_GCDRevisionNumber()
```
    Returns the value of the GCDRevisionNumber property. For more information, see GCDRevisionNumber Property.
  - get_EventExportStores
```
CmEventExportStoreSet get_EventExportStores()
```
    Returns the value of the EventExportStores property. For more information, see EventExportStores Property.
  - get_TextSearchAffinityGroups
```
CmTextSearchAffinityGroupSet get_TextSearchAffinityGroups()
```
    Returns the value of the TextSearchAffinityGroups property. For more information, see TextSearchAffinityGroups Property.
  - get_DomainType
```
DomainType get_DomainType()
```
    Returns the value of the DomainType property. For more information, see DomainType Property.
  - set_DomainType
```
void set_DomainType(DomainType value)
```
    Sets the value of the DomainType property. For more information, see DomainType Property.
  - get_SystemUserName
```
java.lang.String get_SystemUserName()
```
    The name for the system user account.
  - set_SystemUserName
```
void set_SystemUserName(java.lang.String value)
```
    The name for the system user account. Settability Restrictions: None.
  - get_SystemUserPassword
```
byte[] get_SystemUserPassword()
```
    The password for the system user account.
  - set_SystemUserPassword
```
void set_SystemUserPassword(byte[] value)
```
    The password for the system user account. Settability Restrictions: None.
  - get_KeyServiceType
```
java.lang.String get_KeyServiceType()
```
    Specifies the type of the external service managing cryptographic keys on behalf on the Content Platform Engine.
  - set_KeyServiceType
```
void set_KeyServiceType(java.lang.String value)
```
    Specifies the type of the external service managing cryptographic keys on behalf on the Content Platform Engine. Settability Restrictions: None.
  - get_KeyServiceConnection
```
java.lang.String get_KeyServiceConnection()
```
    Specifies the parameters for connecting to the external service managing cryptographic keys on behalf on the Content Platform Engine.
  - set_KeyServiceConnection
```
void set_KeyServiceConnection(java.lang.String value)
```
    Specifies the parameters for connecting to the external service managing cryptographic keys on behalf on the Content Platform Engine. Settability Restrictions: None.
  - get_LocalGroupsEnabled
```
java.lang.Boolean get_LocalGroupsEnabled()
```
    Enables use of local groups for this domain.
  - set_LocalGroupsEnabled
```
void set_LocalGroupsEnabled(java.lang.Boolean value)
```
    Enables use of local groups for this domain. Settability Restrictions: None.
  - get_ElasticSearchClusters
```
CmElasticSearchClusterSet get_ElasticSearchClusters()
```
    A collection of the Elastic Search clusters defined for the domain,
  - get_UpgradeStatus
```
UpgradeStatus get_UpgradeStatus()
```
    Specifies the upgrade status of the domain.
  - set_UpgradeStatus
```
void set_UpgradeStatus(UpgradeStatus value)
```
    Specifies the upgrade status of the domain. Settability Restrictions: None.
  - get_CredentialsManagers
```
CmCredentialsManagerSet get_CredentialsManagers()
```
    A collection of all the Credentials Manager instances defined in the domain.

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

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_Name

set_Name

get_ObjectStores

get_Id

get_Permissions

set_Permissions

get_PermissionDescriptions

get_MarkingSets

get_AddOns

get_DefaultSite

set_DefaultSite

get_Sites

get_FixedContentDevices

get_SubsystemConfigurations

set_SubsystemConfigurations

get_ContentCacheAreas

get_IsolatedRegions

get_PEConnectionPoints

get_DirectoryConfigurations

set_DirectoryConfigurations

get_ExternalRepositories

get_ReplicationGroups

get_ObjectStoreSchemaDB2

get_ObjectStoreSchemaMSSQL

get_ObjectStoreSchemaOracle

get_ObjectStoreSchemaPostgreSQL

get_ObjectStoreSchemaMySQL

get_TextSearchServers

get_DatabaseConnections

get_DocumentationURL

get_GCDRevisionNumber

get_EventExportStores

get_TextSearchAffinityGroups

get_DomainType

set_DomainType

get_SystemUserName

set_SystemUserName

get_SystemUserPassword

set_SystemUserPassword

get_KeyServiceType

set_KeyServiceType

get_KeyServiceConnection

set_KeyServiceConnection

get_LocalGroupsEnabled

set_LocalGroupsEnabled

get_ElasticSearchClusters

get_UpgradeStatus

set_UpgradeStatus

get_CredentialsManagers