The following table lists the types derived from IDependentObject .
Derived Types
Type | Description |
---|---|
IAddOnInstallationRecord | Represents a record that contains information pertaining to the installation of an add-on. An object is created whenever an or object is installed on an object store. |
IAsyncProcessingConfiguration | Represents configuration data for asynchronous processing of events. This class allows admininistrative clients to set or access event dispatcher configuration settings. An object can be assigned to objects of the server hierarchy (IDomain, ISite, IVirtualServer, and IServerInstance), and is persisted in the GCD. To create a |
IAuditDefinition | Represents a definition that specifies audit-event parameters. Audit events are set on a per-class basis: use this interface to configure a object for each event that you want to audit for the class. To create a For each To retrieve |
ICenteraSiteSettings | Represents the configuration settings that can be overridden for the EMC Centera fixed content devices on the specified site. For each setting that can be overridden, the object contains a property that, if populated, will override the corresponding property of the same name on the object. |
ICFSImportAgentConfiguration | Configures the importer component of Content Federation Service (CFS). The CFS importer works in conjunction with the CFS exporter to map external documents to FileNet P8 documents in a one-to-one relationship. Specifically, using data extracted from an external repository and loaded into a federator database by the exporter, the importer creates and updates FileNet P8 documents known as federated documents. (For background information on the exporter and on the relationship between the federator database, the IBM Content Integrator instance, and the external repository, see the interface.) A federated document is a FileNet P8 document created as a proxy for an external document, whereby FileNet P8 stores metadata (property values) mirroring the metadata stored in the external repository but keeps only a reference to the external stored content; the federated document accesses the external content in a transparent fashion, and thus behaves, with some limitations, like any other standard FileNet P8 document. The importer creates a new federated document to represent an external document when first importing the external document into FileNet P8. Thereafter, when subsequently re-importing the external document, the importer updates the metadata of the existing federated document. You can associate this import configuration with a server or a group of servers. Specifically, as with all configuration objects belonging to Some site-specific settings might override the settings configured here. For more information, see the The importer runs as part of the Content Engine, and one importer exists for each Content Engine instance. Each importer runs against all of the federator databases that have been defined for the domain (via GCD-stored
|
ICFSSiteSettings | For a particular FileNet P8 site, configures the Content Federation Service (CFS). For information on specifying the site, and on the relationship between the FileNet P8 site and domain, see the property. This configuration works in conjunction with the standard CFS import configuration. For more information, see the interface. |
IChoice | 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. A choice item is a single possible value, or choice, in a choice list. A choice item can be of two possible types: integer or string. An integer-type choice item holds a single integer value and can be assigned only to an integer-valued property. A string-type choice item holds a single string value and can be assigned only to a string-valued property. A The type of data that a Localization is provided by the A A To create a |
IColumnDefinition | Represents the description of a column in a Content Engine database table. A object describes a column used by a object. By reading the properties of these objects, you can query the values contained in a table. |
IContentCacheConfiguration | Defines the configuration for a content cache. This includes, in particular, the file storage area for the cache (the property). A cache configuration can be associated with a server or with a group of servers. More specifically, a In order for a cache area to be used, at least one server must be configured to be part of the same site as the cache. |
IContentConfiguration | Configures the Content Management Subsystem. The Content Management Subsystem is the part of the Content Engine Object Store Service that is responsible for adding and retrieving document content to and from managed storage areas in response to client requests. The ContentConfiguration interface allows the operation of the Content Management Subsystem to be tuned for the local environment in which it is executing. Just as it must do for all other client requests involving the creation, update, or deletion of data in an object store, the Object Store Service must also guarantee transactional integrity with respect to adding content. Guaranteeing the transactional integrity of content upload and storage is one of the primary functions of the Content Management Subsystem. In order to make this guarantee, the process of adding content is divided into two stages: Stage one involves copying content into a temporary location on the server while stage two is primarily concerned with copying the content to its permanent location. Stage one occurs within the context of a client initiated transaction involving content upload; for example, checking in a document. In this stage, the content associated with the object or objects participating in the transaction are copied from the client to a temporary location that is associated with the designated storage area in which the content will ultimately be stored. This temporary location may be a specially designated file system directory, sometimes referred to as the "inbound directory" or it may a table in the database. The type of temporary storage depends on the destination storage area type. Any metadata changes associated with the participating objects are also carried out at this during this stage. At the conclusion of the first stage of the operation, the transaction must be committed in order to make the changes durable. Committing the transaction includes adding a message to the ContentQueue, when processed, that will result in the second stage of the operation to be executed. The fact that the transaction has been committed after stage one necessarily implies that the server guarantees that the second stage will be carried out - even in the event of server disruptions, power failures, etc. It is important to note that after a transaction involving content upload has been committed, that is, after stage one has completed, the new content has functionally been added to the storage area; a user can retrieve (or perform any other legal operation) on the new content just like any other content in the storage area, despite the fact that it may actually still reside in the temporary storage location. At the conclusion of stage one of the operation or at anytime during its execution, the transaction can also be aborted and, therefore, must be rolled back. Rolling back a transaction in simple terms means guaranteeing that any intermediate changes that occurred during the execution of the transaction will be undone so that the system is restored to the state that it was in prior to the transaction and guaranteeing that none of these changes will be visible to any other transaction while they are being cleaned up. With respect to content upload there are two categories of changes that need to be undone: Metadata changes and content that has been copied to the temporary storage area. The cleanup of the former is handled by the normal transaction processing mechanisms provided by the Object Store Service but the latter is a special case and is managed by the Content Management Subsystem. The way it works is temporary content is flagged as "abandoned". While it is in this state it is invisible to clients and is effectively "not there" from the client's point of view. The Content Management Subsystem then periodically sweeps the temporary storage areas and deletes all abandoned content. Many of the functions of the Content Management Subsystem described above are parameterized such that their behavior can be modified. This is the purpose of the ContentConfiguration interface: To expose those aspects of content operations that can be adjusted in order to optimize the performance of the Object Store Service within a given operational environment. |
IDirectoryConfiguration | Represents the base configuration object for all security providers and holds directory configuration data. The object is used to configure the directory service providers that are used for authorization checks within the servers. You can create one or more |
IDirectoryConfigurationAD | Represents the configuration object for the Active Directory security provider. You must create a configuration object for each Active Directory forest that is accessed by the FileNet P8 domain. For example, if you have two Active Directory forests to be accessed by the FileNet P8 domain, you need to create two Active Directory-specific objects--one for each forest. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
IDirectoryConfigurationAdam | |
IDirectoryConfigurationCA | This interface is not supported. An instance represents the configuration object for a CA eTrust security provider. |
IDirectoryConfigurationIBM | Represents the configuration object for an IBM Tivoli security provider. An IBM Tivoli directory server can be mapped to multiple FileNet P8 realms. Each FileNet P8 realm has a one-to-one relationship with the authentication provider. There is also a one-to-one relationship between a FileNet P8 object and a object. Therefore, you must create one object for each authentication provider in each realm. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
IDirectoryConfigurationNovell | Represents the configuration object for a Novell eDirectory security provider. A Novell eDirectory server can be mapped to multiple FileNet P8 realms. Each FileNet P8 realm has a one-to-one relationship with the authentication provider. There is also a one-to-one relationship between a FileNet P8 object and a object. Therefore, you must create one object for each authentication provider in each realm. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
IDirectoryConfigurationSunOne | Represents the configuration object for a SunOne security provider. A SunOne directory server can be mapped to multiple FileNet P8 realms. Each FileNet P8 realm has a one-to-one relationship with the authentication provider. There is also a one-to-one relationship between a FileNet P8 object and a object. Therefore, you must create one object for each authentication provider in each realm. To create an instance of the class, call . The group of type-specific directory configuration objects is contained in the collection object. |
IImageServicesClassDescription | Represents the description of an Image Services document class. |
IImageServicesImportAgentConfiguration | Represents configuration data for an Image Services import operation. |
IImageServicesPropertyDescription | Represents the description of an Image Services document class property. |
IImageServicesSiteSettings | Represents the configuration settings that can be overridden for the Image Services fixed content devices on the specified site. For each setting that can be overridden, the object contains a property that, if populated, will override the corresponding property of the same name on the object. |
IIndexJobClassItem | Identifies the class to be full text indexed. When a property or class is enabled or disabled for indexing, objects with newly enabled properties/classes need to be indexed, and objects with newly disabled properties/classes need to be removed from the index. The specified class can be any base class (such as, or ), or any of its subclasses, that support indexing. All instances of the specified class are indexed. Warning: Do not change the If the class selected to index is a base class ( Note: For indexing purposes, the For |
IIndexJobCollectionItem | Identifies a Verity collection to be full text indexed. When the indexing data for one or more Verity collections becomes corrupted or lost (due to a storage device failure), the collection needs to be reindexed. This operation deletes the current indexing data, and creates new full text index data to replace it. Warning: Do not use collection indexing to address a change in the |
IIndexJobItem | Indicates a particular item that is being full text indexed. |
IIndexJobSingleItem | Identifies an object to be full text indexed. When the original index attempt results in an indexing failure for a single object (such as a or object), or some aspect of the configuration (such as a Verity style file) needs to be changed, the affected object can be reindexed. Performing this operation on an object whose class is CBR enabled attempts to reindex the object. Performing this operation on an object whose class is not CBR enabled attempts to delete the object from any existing indexes. |
ILocalizedString | Provides a means of support for locale-specific display names and descriptive text used by a class definition or property template. You can create an instance of a |
IPropertyDefinition | Represents the base class for all property definition classes. A property definition is created from a property template and holds mutable property metadata. Each property definition class corresponds to a specific property data type (for example, defines a property that returns a binary value, defines a property that returns a Boolean value, and so on). When a property definition is added to a class definition's collection, a user-defined property is added to that class. |
IPropertyDefinitionBinary | Represents the definition of a property that holds a binary value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPropertyDefinitionBoolean | Represents the definition of a property that holds a Boolean value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPropertyDefinitionDateTime | Represents the definition of a property that holds a DateTime value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPropertyDefinitionFloat64 | Represents the definition of a property that holds a Double (Float64) value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPropertyDefinitionId | Represents the definition of a property that holds a GUID string value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPropertyDefinitionInteger32 | Represents the definition of a property that holds an integer value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPropertyDefinitionObject | Represents the definition of a property that holds a Content Engine object value. A object is created from a object and contains mutable metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPropertyDefinitionString | Represents the definition of a property that holds a string value. A object is created from a object and contains mutable property metadata that you can customize. When a object is added to a class definition's collection, a user-defined property is created in that class. |
IPublishingConfiguration | References the configuration data for a publishing operation. This class allows admininistrative clients to set or access publishing-related configuration settings. A object can be assigned to objects of the server hierarchy ( , , , and ), and is persisted in the GCD. |
IReplicationConfiguration | Represents configuration settings for the replication components of a server. |
IServerCacheConfiguration | Defines configuration options for all server caches that do not have object store-specific characteristics. The options apply to the following caches: code module cache, GCD cache, marking set cache, metadata cache, subject cache, and user token cache. Options include a time-to-live (TTL) value for managing cache entry residency and a value that, when exceeded, triggers cache refresh activity on a least-recently-used basis. (Object store-related cache options, such as folder cache TTL and object security cache attributes, are set at the object store level.) The To create a new instance, call The |
ISiteSettings | Represents an abstract, dependent object that provides site-specific, configuration value overrides. For each fixed content device type with settings that can be overridden, a corresponding subclass of is defined with properties that, if populated, will override the corresponding properties of the same name on the fixed content device object. |
ISubsystemConfiguration | Represents a configuration object related to a particular subsystem or functional area that can be configured relative to a server hierarchy. This interface is the superclass for configuration objects. For each object in the hierarchy, there are a number of associated configuration objects. Each of these configuration objects has one or more attributes defining various configuration options for a particular subsystem area (such as content cache, server caching, trace logging, and so on). All of the configuration objects available on the objects of the server hierarchy ( |
ITraceLoggingConfiguration | Configures and enables trace logging on the Content Engine host for the supported subsystems. Each of the supported subsystems is a property on this class, enabling trace logging to be configured per subsystem. Configuring trace logging for a subsystem applies the trace logging settings to all classes in that subsystem. The constant class contains the trace log settings available. These settings can be ORed together to apply multiple settings to a subsystem. The property on this ( ) class enables or disables trace logging for all of the configured subsystems. Use the property to specify the output destination classes for the trace logs. Trace logging is implemented using the Apache log4j package (org.apache.log4j). |
IVerityCollection | Identifies the full text indexing information used for a particular base class and all of its subclasses. A is associated with only one IndexArea, and the full text information is stored in a file system directory identified by the . For each
An application can set the The New indexing information is written only to collections having a status of "open". However, all collections, regardless of their status, are searched when queries are performed. To prevent a collection from being searched, the associated |
IVerityServerConfiguration | Contains the Verity configuration data (properties) for a server instance. This configuration data can differ from one server to the next. A object is contained in the property of , , , and objects. The object used is the first occurrence found by searching (in this order) the instance, the instance, the instance, and the instance. None of the properties on this object must be set or changed to enable full text indexing. This object is used only to address performance issues. |
IContentElement | Represents the superclass for classes used to access document or annotation content data. Each content element represents content data, which can either be local to an object store (represented by an object) or external to an object store and therefore outside the control of the Content Engine server (represented by a object). |
IContentReference | Represents external content data that exists outside of an object store (and therefore outside the control of the Content Engine server), but to which an object store maintains a reference. The URL of the resource that contains the content data is stored in the property. |
IContentTransfer | Represents content data that is local to an object store and directly managed by the Content Engine server. |
IDocumentState | Represents a valid lifecycle state of a document lifecycle policy. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken and which access permissions to be applied when a document's lifecycle state changes. To define the lifecycle states in a document lifecycle policy, create a object for each lifecycle state that you want to define and add it to a object's collection. Each lifecycle state must have a name, which is set by the The order of the lifecycle states in a document lifecycle policy's The template permissions specified by the |
ISubscribedEvent | A object represents a system or custom event that applies to a object. You add a object to a subscription via the object's property. You set this property to a collection. To create a You can get a reference to a |
IPropertyDescription | Represents the base class for all property description classes. A property description object holds immutable metadata that describes a specific class property. Each property description class corresponds to a specific property data type (for example, defines a property that returns a binary value, defines a property that returns a Boolean value, and so on). Because all of its properties are read-only, you cannot directly modify a property description object. |
IPropertyDescriptionBinary | Represents the fixed description of a property that holds a binary value. A object contains immutable property metadata, which you cannot directly modify. |
IPropertyDescriptionBoolean | Represents the fixed description of a property that holds a Boolean value. A object contains immutable property metadata, which you cannot directly modify. |
IPropertyDescriptionDateTime | Represents the fixed description of a property that holds a DateTime value. A object contains immutable property metadata, which you cannot directly modify. |
IPropertyDescriptionFloat64 | Represents the fixed description of a property that holds a Double (Float64) value. A object contains immutable property metadata, which you cannot directly modify. |
IPropertyDescriptionId | Represents the fixed description of a property that holds a GUID string value. A object contains immutable property metadata, which you cannot directly modify. |
IPropertyDescriptionInteger32 | Represents the fixed description of a property that holds an integer value. A object contains immutable property metadata, which you cannot directly modify. |
IPropertyDescriptionObject | Represents the fixed description of a property that holds a Content Engine object value. A object contains immutable property metadata, which you cannot directly modify. |
IPropertyDescriptionString | Represents the fixed description of a property that holds a string value. A object contains immutable property metadata, which you cannot directly modify. |
IExternalAlias | Represents the mechanism for mapping an external class or property to a corresponding Content Engine class or property. This interface is the base for subinterfaces representing external class and property aliases. |
IExternalClassAlias | Represents the mechanism for mapping an external class to a corresponding Content Engine class. |
IExternalIdentity | Represents the identity of a replicated object in an external repository. |
IExternalParticipant | This interface is not supported. |
IExternalPropertyAlias | Represents the mechanism for mapping an external class property to a corresponding Content Engine class property. |
IExternalPropertyDescription | Represents the description of a class property in an external repository. |
IObjectStoreParticipant | Represents an object store participant of a replication group. |
IReplicationParticipant | This interface is the base for subinterfaces representing external repository or object store participants in a replication group. |
IAccessPermission | Defines access permissions through a bitmask of access rights. You can create an instance of this class by calling on the class. |
IAccessPermissionDescription | Describes an access right or level. This interface provides helper methods that you can use to retrieve descriptive information for a particular access right or access level (a commonly-used combination of access rights) for a particular object. The most typical use of this interface's methods is to populate a security edit dialog. For example, you can retrieve a The user must have Read ( You can get an instance of this object in the following ways:
These methods return an |
IActiveMarking | Represents a marking that is currently applied to a given object. Any object that can have a marking can be assigned one or more markings. A marking that is assigned to an object is called an active marking. An From the properties on this interface, you can retrieve the value of the associated You cannot create a new |
IApplicationSecurityTemplate | Represents a template through which an application can apply permissions (access rights) to a , , or object, and to their subclasses. Security templates are not independently persistable to the Content Engine; they are contained in a object. The template contains the permissions that will be applied to an object by the application program. An object also has associated objects, each of which provide descriptive information for an access right or level. You can enable or disable a template within its security policy container. An enabled template can be applied to an object; a disabled template remains an item in the security policy container but cannot be applied to an object. A To create an instance of |
IDiscretionaryPermission | Base class for permission objects that define discretionary access permissions. The object's owner grants individual users or groups access rights to the object based on the grantee's identity and group memberships. |
IMarking | Represents the definition of a value that may be assigned to a marking-controlled property. Markings provide an additional, optional layer of security that is primarily designed for the records management marketplace, but which can also be applied by non-records management applications. Markings allow controlled access to objects based on specific property values. The set of definitions for all possible objects is contained in a collection. A marking represents a single item in a set of markings. For example, if a set of markings is called Security Codes, items within the set might be Top Secret, Secret, Confidential, and so on. Each of those marking values contains a set of access permissions that define who can assign that specific value to an object property, who can modify or remove that specific value, and, once the value is assigned, who will have access to the object to which the value is assigned. You can assign one or more of these markings to an object. To then be able to access that object, a user must be granted sufficient access from all assigned markings. The set of all active markings (that is, those that are currently assigned to a given object) are contained in an The user's access to an object is represented by an effective access mask. The effective access is calculated using the object's permission list and subtracting the constraint mask of the applied markings. The resulting effective access is used to control what that user can do with the object. |
IPermission | Represents the base class for objects. A You can get a You can optionally set the A permission can be acquired from several sources: direct, default, a security parent, or a security template. A permission's source is direct as a result of explicitly setting the object's permission, for example, by calling |
IPermissionDescription | Base class for objects describing permissions. |
ISecurityTemplate | Represents the base class for security template classes. The templates are contained within a security policy and can be one of two types: versioning or application templates. For more information on each of these types, refer to the interface descriptions for |
IVersioningSecurityTemplate | Represents a template for automatically applying permissions (access rights) to a object during versioning state changes. Security templates are not independently persistable to the Content Engine; they are contained in a object. The template contains the permissions that will be applied to an object as its version state changes. A object also has associated objects, each of which provide descriptive information for an access right or level. You can enable or disable a template within its security policy container. An enabled template can be applied to an object; a disabled template remains an item in the security policy container but cannot be applied to an object. A If an object has no associated security policy, its permissions remain unchanged when it undergoes a versioning change. However, if the object has an associated
To create a new |