Content Engine Java API: com.filenet.api.admin

Interface Summary
Interface	Description
AddOn	Represents a product extension to the core FileNet P8 Content Engine components.
AddOnInstallationRecord	Represents a record that contains information pertaining to the installation of an add-on.
AsyncProcessingConfiguration	Represents configuration data for asynchronous processing of events.
AsyncUpgradeQueueItem	For internal use only.
AuditDefinition	Represents a definition that specifies audit-event parameters.
CenteraFixedContentDevice	Represents the description of an EMC Centera fixed content device.
CenteraSiteSettings	Represents the configuration settings that can be overridden for the EMC Centera fixed content devices on the specified site.
CFSImportAgentConfiguration	Configures the importer component of Content Federation Service (CFS).
CFSSiteSettings	For a particular FileNet P8 site, configures the Content Federation Service (CFS).
Choice	Represents a single choice item in a choice list that can be assigned to a property, or represents a group node for a nested collection of choice items within a choice list.
ChoiceList	Represents a choice list in an object store.
ClassDefinition	Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes.
CmAbstractQueueEntry	Customizable base for classes of objects that can be processed by a queue sweep.
CmAtmosFixedContentDevice	This class is not currently supported.
CmAuditDispositionPolicy	Defines the criteria in which audit records are identified for disposition (deletion).
CmAuditingConfiguration	Represents configuration data for audit disposition, a subsystem for automatic pruning (deletion) of audited events in the Content Engine audit log (Event table).
CmAuditProcessingBookmark	Represents a leave-off point in the audit log (Event table), which indicates the last record processed by an audit processing client, such as an analytics or case history application.
CmChangePreprocessorDefinition	Associates a `CmChangePreprocessorAction` object with a class definition.
CmDatabaseConnection	Contains database connection information for object stores, event export stores, and isolated regions.
CmDirectoryConfigurationConnections	Represents the configuration object for the IBM Connections provider.
CmDirectoryConfigurationDomino	Configuration object for Domino LDAP security provider.
CmDirectoryConfigurationOID	Represents the configuration object for an Oracle Internet Directory (OID) security provider.
CmDirectoryConfigurationRadiantOne	Represents the configuration object for a RadiantOne security provider.
CmDirectoryConfigurationVMM	Represents the configuration object for the Content Platform Engine's VMM provider.
CmEventExportStore	Represents an event export store used by the Case Analyzer or Case History publishing service.
CmHitachiFixedContentDevice	Represents the description of a Hitachi Content Platform fixed content storage device.
CmHold	Represents a hold on an object of type `CmHoldable`, preventing that object from being deleted for an indefinite period of time, until the hold is explicitly removed.
CmHoldable	Abstract base class for classes to which holds (deletion prevention) can be applied.
CmHoldRelationship	Defines a hold-held relationship between `CmHold` (hold object) and `CmHoldable` object (the held object).
CmIndexJobResyncItem	Represents an index job that resynchronizes a full-text index with the data in an object store database.
CmIndexPartitionConstraint	Represents an index partition constraint associated with an IBM® Content Search Services index.
CmIndexPartitionConstraintDate	Represents the date range of a date partition constraint for an IBM® Content Search Services index.
CmIndexPartitionConstraintString	Represents the name and value of a string partition constraint for an IBM® Content Search Services index.
CmIndexRequest	Represents the base class for index requests.
CMODApplicationGroup	Represents an IBM® Content Manager OnDemand (CMOD) application group that can be configured for content federation.
CMODFixedContentDevice	Represents the description of an IBM® Content Manager OnDemand (CMOD) external fixed content storage device.
CmProcessEngineConfiguration	Specifies configuration settings for the Process Engine, including the Case Analyzer and Case History publishing services.
CmQueueEntryClassDefinition	Mutable metadata class defining a subclass of `CmAbstractQueueEntry`.
CmTextSearchAffinityGroup	Represents an affinity group of IBM® Content Search Services servers.
CmTextSearchConfiguration	Represents the configuration information for Content Engine server dispatcher and worker threads, which control the processing of IBM® Content Search Services content indexing requests.
CmTextSearchIndex	Represents an IBM® Content Search Services index, which holds the full-text indexing information that is created, updated, and searched by an IBM Content Search Services server.
CmTextSearchIndexArea	Represents the configuration of an IBM® Content Search Services index area.
CmTextSearchIndexRequest	Represents an index request generated for a text search-enabled object for IBM® Content Search Services.
CmTextSearchPartitionDateProperty	Represents a custom, date-valued CBR-enabled object property that is assigned in an object store to define the interval for date-based partitioning of CBR-enabled objects in an IBM® Content Search Services index.
CmTextSearchPartitionProperty	Represents the base, abstract class whose instances refer to IBM® Content Search Services index partioning properties of CBR-enabled objects in an object store.
CmTextSearchPartitionStringProperty	Represents a custom, string-valued CBR-enabled object property that is assigned in an object store to define the string-based partitioning of CBR-enabled objects in an IBM® Content Search Services index.
CmTextSearchServer	Represents the connection and configuration information for an IBM® Content Search Services server.
CmThreadPoolConfiguration	Configures the server thread pools for background tasks.
CmTimeslot	Defines a schedule for a text-indexing, audit-disposition, or sweep-job background task.
CmTivoliManagementClass	A management class that represents a specific retention setting for an IBM® Tivoli® Storage Manager (TSM) server.
CmVerityIndexRequest	Deprecated As of release 5.2.0.
CodeModule	Represents a Java action handler to be stored on the Content Engine.
ColumnDefinition	Represents the description of a column in a Content Engine database table.
ContentCacheArea	Represents a file storage area that stores duplicates of the document content most frequently requested, and permits those duplicates to be accessed in lieu of the originals in order to enhance the document retrieval performance of local servers.
ContentCacheConfiguration	Defines the configuration for a content cache.
ContentConfiguration	Configures the Content Management Subsystem.
DatabaseStorageArea	Represents a storage area for content elements stored in the database.
DirectoryConfiguration	Represents the base configuration object for all security providers and holds directory configuration data.
DirectoryConfigurationAD	Represents the configuration object for the Active Directory security provider.
DirectoryConfigurationAdam	Represents the configuration object for an ADAM or AD LDS security provider.
DirectoryConfigurationCA	Represents the configuration object for an CA (Computer Associates International Inc.) eTrust security provider.
DirectoryConfigurationIBM	Represents the configuration object for an IBM Tivoli security provider.
DirectoryConfigurationNovell	Represents the configuration object for a Novell eDirectory security provider.
DirectoryConfigurationSunOne	Represents the configuration object for a Oracle (formerly SunOne) security provider.
DITARenditionEngineConnection	Represents site-specific connection data for a DITA Rendition Engine that is referenced by a publishing configuration.
DocumentClassDefinition	Represents the class definition (mutable class metadata) of the `Document` class and its subclasses.
DocumentClassificationQueueItem	Represents a pending (queued) document auto-classification request.
EventClassDefinition	Represents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited.
EventQueueItem	Represents a pending (queued) execution of an asynchronous event action, or an asynchronous event queue item that remains unprocessed because its retry count is zero.
FileStorageArea	Represents a storage area for content elements stored in the file system.
FixedContentDevice	Represents the base, abstract class for all classes relating to fixed content devices.
FixedStorageArea	Represents a storage area for content elements stored in a fixed content device.
GenericFixedContentDevice	Represents the description of a generic fixed content device.
IICEFixedContentDevice	Represents an external fixed content device accessible via an instance of IBM Content Integrator (formerly known as Information Integrator Content Edition or IICE).
ImageServicesClassDescription	Represents the description of an Image Services document class.
ImageServicesImportAgentConfiguration	Represents configuration data for an Image Services import operation.
ImageServicesPropertyDescription	Represents the description of an Image Services document class property.
ImageServicesSiteSettings	Represents the configuration settings that can be overridden for the Image Services fixed content devices on the specified site.
IMFixedContentDevice	Represents the description of a FileNet Image Services fixed content device.
IndexArea	Represents the disk storage location and data necessary to perform full-text indexing for content-based retrieval.
IndexJob	Initiates and tracks the status of a full-text indexing operation.
IndexJobClassItem	Identifies the class to be full-text indexed.
IndexJobCollectionItem	Identifies an IBM® Content Search Services index to be full-text indexed.
IndexJobItem	Indicates a particular item that is being full text indexed.
IndexJobSingleItem	Identifies an object to be full-text indexed.
IsolatedRegion	Contains the connection information necessary to access the isolated region of a workflow system.
LocalizedString	Provides a means of support for locale-specific display names and descriptive text used by a class definition or property template.
PEConnectionPoint	Routes Process Engine requests to an isolated region (`IsolatedRegion` instance).
PropertyDefinition	Represents the base class for all property definition classes.
PropertyDefinitionBinary	Represents the definition of a property that holds a binary value.
PropertyDefinitionBoolean	Represents the definition of a property that holds a Boolean value.
PropertyDefinitionDateTime	Represents the definition of a property that holds a DateTime value.
PropertyDefinitionFloat64	Represents the definition of a property that holds a Double (Float64) value.
PropertyDefinitionId	Represents the definition of a property that holds a GUID string value.
PropertyDefinitionInteger32	Represents the definition of a property that holds an integer value.
PropertyDefinitionObject	Represents the definition of a property that holds a Content Engine object value.
PropertyDefinitionString	Represents the definition of a property that holds a string value.
PropertyTemplate	Represents the base class for all property template classes.
PropertyTemplateBinary	Represents a property template for creating `PropertyDefinitionBinary` objects, which you can add to class definitions to create user-defined properties for holding binary values.
PropertyTemplateBoolean	Represents a property template for creating `PropertyDefinitionBoolean` objects, which you can add to class definitions to create user-defined properties for holding Boolean values.
PropertyTemplateDateTime	Represents a property template for creating `PropertyDefinitionDateTime` objects, which you can add to class definitions to create user-defined properties for holding DateTime values.
PropertyTemplateFloat64	Represents a property template for creating `PropertyDefinitionFloat64` objects, which you can add to class definitions to create user-defined properties for holding Double (Float64) values.
PropertyTemplateId	Represents a property template for creating `PropertyDefinitionId` objects, which you can add to class definitions to create user-defined properties for holding GUID string values.
PropertyTemplateInteger32	Represents a property template for creating `PropertyDefinitionInteger32` objects, which you can add to class definitions to create user-defined properties for holding integer values.
PropertyTemplateObject	Represents a property template for creating `PropertyDefinitionObject` objects, which you can add to class definitions to create user-defined properties for holding Content Engine object values.
PropertyTemplateString	Represents a property template for creating `PropertyDefinitionString` objects, which you can add to class definitions to create user-defined properties for holding string values.
PublishingConfiguration	References the configuration data for a publishing operation.
QueueItem	This class is the base class for all queue-related classes.
RenditionEngineConnection	Represents site-specific connection data for a Rendition Engine that is referenced by a publishing configuration.
ReplicableClassDefinition	Represents the class definition (mutable class metadata) of classes of which an object instance can be replicated.
ReplicationConfiguration	Represents the configuration settings for the replication components of a server.
SecurityPropagationQueueItem	Represents a pending (queued) execution of an asynchronous security propagation action on a target object.
ServerCacheConfiguration	Defines configuration options for all server caches that do not have object store-specific characteristics.
ServerInstance	Represents a single instance of a Java Virtual Machine (JVM) running in an application server.
Site	Identifies a geographical area within a FileNet P8 domain.
SiteSettings	Represents an abstract, dependent object that provides site-specific, configuration value overrides.
SnapLockFixedContentDevice	Represents the description of a NetApp SnapLock fixed content device.
StorageArea	Represents the physical storage location where content will be stored.
StoragePolicy	Represents a subset of available storage areas that are deemed equivalent based on common, user-specified criteria.
SubscribableClassDefinition	Represents the class definition (mutable class metadata) of classes whose instances can be the target of a subscription and can be audited.
SubsystemConfiguration	Represents a configuration object related to a particular subsystem or functional area that can be configured relative to a server hierarchy.
TableDefinition	Represents the description of a Content Engine database table.
TivoliFixedContentDevice	Represents the description of an IBM® Tivoli® Storage Manager (TSM) server fixed content device.
TraceLoggingConfiguration	Configures and enables trace logging on the Content Engine host for the supported subsystems.
UpgradeAddOn	Specifies how to upgrade a set of existing add-ons to a new set of add-ons.
VerityCollection	Deprecated As of release 5.2.0.
VerityDomainConfiguration	Deprecated As of release 5.2.0.
VerityIndexArea	Deprecated As of release 5.2.0.
VerityServerConfiguration	Deprecated As of release 5.2.0.
VersionableClassDefinition	Represents the parent of the `DocumentClassDefinition` class, which holds the class definition of a `Document` class and its subclasses.
VirtualServer	Represents a logical entity for managing a group of server instances.
XMLPropertyMappingScript	Represents the definition of a `Document` subclass for defining XML property mapping scripts.

Class Summary
Class Description

ContentValidationRequest
Represents a data object to be used with the batch form of StorageArea.validateContent.

Class Summary
Class	Description
ContentValidationRequest	Represents a data object to be used with the batch form of `StorageArea.validateContent`.

Package com.filenet.api.admin Description

Provides classes and interfaces that are used in the administration of a FileNet P8 Content Engine Server. These classes are used to configure servers and content storage devices within a geographical site, to configure full text indexing and directory service access parameters, and to perform related tasks. This package also contains the classes used to author custom metadata (the class and property definitions that define application-specific metadata). Most of the administration classes reside in the FileNet P8 domain's Global Configuration Data (GCD) database, outside of any object store (although the metadata authoring objects are defined within an object store).