Provides classes and interfaces that are related to
the core business objects of the API, such as
,
,
,
, and so on.
This namespace also provides factory classes for instantiating objects.
Classes
Interfaces
Interface | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
IAnnotation | Represents an annotation that can be applied to a document, folder, or custom object. An object allows you to link additional information to a containable object. You can modify and delete annotations independently of their annotated object. However, you cannot create versions of an annotation separately from the object with which it is associated. Document annotations are uniquely associated with a single document version; they are not versioned or carried forward when their document version is updated and a new version created. By design, an annotation is deleted whenever its associated parent object is deleted. Although an annotation receives its default security from both the annotation's class and parent object, you can apply security to an annotation that is different from the security applied to its parent. To create a new |
||||||||||
![]() |
IBatchItemHandle | References objects for batch operations. A batch contains a list of |
||||||||||
![]() |
IComponentRelationship | Defines a hierarchical relationship between two documents as components in a compound document. One document is the designated parent component ( The two documents in a component relationship might be bound to each other as a result of that relationship. Document binding means the child component document exists in the child documents collection ( The two documents in a component relationship do not have to belong to the same object store. Also, these documents can continue to be used and referenced as individual documents, just as if they had never entered into a component relationship with each other. The parent component document determines security for each instance of this class. Users with write permission ( |
||||||||||
![]() |
IConnection | Represents a logical connection to a FileNet P8 domain. A domain connection is required to obtain a reference to any object stores within that domain. A A You can create a Once you have obtained a |
||||||||||
![]() |
IContainable | Represents the base class for all objects that can be contained. objects and their subclasses can be directly contained in a object, or referentially contained (using the or classes). All other subclasses are referentially contained. Note: Folders that are referentially contained cannot participate in hierarchy index searches. |
||||||||||
![]() |
IContainmentRelationship | Models containment relationships. These can be either or objects. |
||||||||||
![]() |
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. | ||||||||||
![]() |
ICustomObject | Represents a general interface that can be subclassed. A object has no inherent semantics, but is independently securable and can be persisted to an object store. A does not carry content, is not versionable, and does not support lifecycle functionality. The |
||||||||||
![]() |
IDependentObject | Indicates objects that are dependent. A The identity and security of a dependent object are derived from that of its parent independent object.
Any attempt to assign an already-assigned Note: While this type of operation might succeed with the 4.0 Content Engine API, the behavior is unreliable and future releases of the Content Engine API will prohibit reuse by throwing a runtime exception. |
||||||||||
![]() |
IDocument | Represents a single version of a document stored in an object store. In addition to being versionable, a object can be subclassed and can carry content, which is stored in one or more content elements. Each content element represents content data, which can either be local to an object store (represented by a object) or external to an object store and therefore outside the control of the Content Engine server (represented by a object). In addition, a object can be associated with 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 when a document's lifecycle state changes. |
||||||||||
![]() |
IDomain | 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 |
||||||||||
![]() |
IDynamicReferentialContainmentRelationship | Represents a dynamic relationship between two subclasses: a container and the current version of a . The object-valued and properties express the relationship. The tail always references a (the container), while the head references the current version of a . |
||||||||||
![]() |
IEngineObject | Represents the top-level interface from which most of the other Content Engine API interfaces derive. An You will not normally work directly with an This interface provides some base functionality, such as retrieving the |
||||||||||
![]() |
IEntireNetwork | Represents the highest-level object in the Content Engine API object model. Creating an instance of this object exposes all other public members of the object hierarchy. For example, from , you can instantiate a object. From a domain, you can navigate to an object store, then begin accessing documents, folders, etc. You can also use the to retrieve all of the objects for the FileNet P8 domain, then retrieve the users and groups associated with a realm. You can create a new |
||||||||||
![]() |
IFolder | Represents a container that can hold other subclasses, but cannot have content data of its own. Although objects and their subclasses can be referentially contained, they are the only Containable subclass that can be directly contained (in a ). All other subclasses are referentially contained using the or classes. Note: Folders that are referentially contained cannot participate in hierarchy index searches. The container hierarchy is a one-to-many relationship: a folder can have many child folders, but a child folder can have only one parent folder. At the top of the container hierarchy is an automatically-created root folder. Use Folders are not versionable. |
||||||||||
![]() |
IIndependentlyPersistableObject | Represents a persistable that you can directly create, update, and delete. |
||||||||||
![]() |
IIndependentObject | Indicates objects that are independent. An An When calling the |
||||||||||
![]() |
IInstantiatingScope | Provides a generic means for instantiating independent objects within a scope. An
|
||||||||||
![]() |
ILink | Represents a relationship between two objects. The object-valued and properties express the relationship. Use a Link object for many-to-many relationships between any objects, or for referential containment relationships between objects that are not instances of subclasses. Note: This is a weak link relationship: both the |
||||||||||
![]() |
IObjectReference | Provides a means to retrieve identity information about an object. Its methods primarily allow you to retrieve an object’s ID, as well as its associated class and object store IDs. You can get an instance of an object’s unique identity by calling
|
||||||||||
![]() |
IObjectStore | Represents a location in which folders, documents, and custom objects are stored, accessed, and managed on the Content Engine server. An You can get a reference to an
|
||||||||||
![]() |
IReferentialContainmentRelationship | Represents a static relationship between two subclasses: a container and a containee. The object-valued and properties express the relationship. The tail always references a (the container), while the head references the containee: another subclass (such as another , a , or a ). When the head is a object, it represents a specific document version. |
||||||||||
![]() |
IRelationship | Represents the base class for binary relationships between independently persistable objects of an object store. | ||||||||||
![]() |
IRepositoryObject | Indicates objects that are repository objects. A You will not normally work directly with a |
||||||||||
![]() |
IScope | Defines the originating "scope" (enclosing context) of an object, such as the of a or , or the of a . Classes are generally characterized by where the instance objects reside. Some objects reside within an
The following table lists scope objects and the objects scoped to them:
|
||||||||||
![]() |
ISubscribable | Serves as a target of an event subscription, represented by a is a base interface of several derived interfaces that can be used as a subscription target. To set a object as the target of a subscription, use the property of the -based object. You can instantiate a
|
||||||||||
![]() |
IVersionable | Represents the base class for interfaces whose instances are versionable objects. If versioning is enabled on a versionable object (its property is ), it can have multiple versions associated with it in an object store. A versionable object can be checked out, optionally edited, and checked in as a major or a minor version. A major version is either the current released version (if it is the latest major version) or a previous released version that was superseded. A minor version is either the in-process version (if it is the latest minor version) or a previous in-process version that was superseded. When a versionable object is checked out, a reservation object is created, which you can modify. During the check-in operation, the reservation object becomes the current version of the versionable object, therefore creating a new version. All of a versionable object's versions can be accessed by its associated object or from the collection returned by its property. |
||||||||||
![]() |
IVersionSeries | Represents the complete set of versions for a versionable object, or document (that is, an object instantiated from a subinterface of the interface). Because a object is constructed by the server from versionable objects and does not have its state stored in a database, it is read-only, and thus you cannot modify any of its properties. In addition, a object has no security attached to it; it is secured by the current document version associated with it. You can access a specific document version by navigating through the collection returned by the property. Use extreme caution when deleting a object; if you delete it, all of its associated document versions will also be deleted. |
||||||||||
![]() |
IWorkflowDefinition | Represents a workflow definition, an XML document of class "WorkflowDefinition" that is stored in a Content Engine object store. A workflow definition describes the instructions, paths, and queues available to a workflow, and acts as a processing template that the Process Engine uses each time the workflow runs. Workflow definition documents are versionable, containable, and can have a lifecycle associated with them. The To create a new After you create a workflow definition, you link it to an object that implements the To return all of the workflow subscription objects associated with this You can instantiate a
|