com.filenet.api.core
Interface 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 authenticating users.

Although you can programmatically create a domain, it is not typical to do so. (For a code sample, see "Getting Started Procedures" in the IBM FileNet P8 Content Engine .NET and Java API Developer’s Guide.) 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
 AddOnSet get_AddOns()
          Returns the value of the AddOns property.
 ContentCacheAreaSet get_ContentCacheAreas()
          Returns the value of the ContentCacheAreas property.
 Site get_DefaultSite()
          Returns the value of the DefaultSite property.
 DirectoryConfigurationList get_DirectoryConfigurations()
          Returns the value of the DirectoryConfigurations property.
 DITARenditionEngineConnectionSet get_DITARenditionEngineConnections()
          Returns the value of the DITARenditionEngineConnections property.
 java.lang.String get_EncryptionAlgorithm()
          Returns the value of the EncryptionAlgorithm property.
 ExternalRepositorySet get_ExternalRepositories()
          Returns the value of the ExternalRepositories property.
 FixedContentDeviceSet get_FixedContentDevices()
          Returns the value of the FixedContentDevices property.
 Id get_Id()
          Returns the value of the Id property.
 IsolatedRegionSet get_IsolatedRegions()
          Returns the value of the IsolatedRegions property.
 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_ObjectStoreSchemaOracle()
          Returns the value of the ObjectStoreSchemaOracle 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.
 byte[] get_PublicKey()
          Returns the value of the PublicKey property.
 RenditionEngineConnectionSet get_RenditionEngineConnections()
          Returns the value of the RenditionEngineConnections 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.
 VerityDomainConfiguration get_VerityDomainConfiguration()
          Returns the value of the VerityDomainConfiguration property.
 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_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.
 
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_RenditionEngineConnections

RenditionEngineConnectionSet get_RenditionEngineConnections()
Returns the value of the RenditionEngineConnections property. For more information, see RenditionEngineConnections Property.


get_PublicKey

byte[] get_PublicKey()
Returns the value of the PublicKey property. For more information, see PublicKey Property.


get_EncryptionAlgorithm

java.lang.String get_EncryptionAlgorithm()
Returns the value of the EncryptionAlgorithm property. For more information, see EncryptionAlgorithm Property.


get_VerityDomainConfiguration

VerityDomainConfiguration get_VerityDomainConfiguration()
Returns the value of the VerityDomainConfiguration property. For more information, see VerityDomainConfiguration 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_DITARenditionEngineConnections

DITARenditionEngineConnectionSet get_DITARenditionEngineConnections()
Returns the value of the DITARenditionEngineConnections property. For more information, see DITARenditionEngineConnections Property.



© Copyright IBM Corporation 2006, 2008. All rights reserved.