Collections with names ending in Set (such as IDocumentSet) represent independent objects; names ending in List (such as IPermissionList) represent dependent objects. List-type collections contain ordered elements and can be directly updated. The elements of a list-type collection need not be unique. With a few exceptions, set-type collections contain unordered elements and each element will be unique. For information about the exceptions to this general rule, refer to "Collection Concepts" in the IBM FileNet P8 Content Engine Java and .NET API Developer's Guide. Sets cannot be directly updated, but can be iterated. Sets are transparently paged from the server during iteration; lists are not. The IEngineCollection interface defines functionality common to all collections; IEngineSet defines functionality common only to sets.
Interfaces
| Type | Interface | Description |
|---|---|---|
 | IAccessPermissionDescriptionList |
Represents a collection of AccessPermissionDescription objects.
|
| IAccessPermissionList |
Represents a collection of AccessPermission objects.
To create an instance of this object, call Factory.AccessPermission.CreateList().
|
| IActionConsumerSet |
Represents a collection of IActionConsumer objects.
|
| IActionSet |
Represents a collection of IAction objects.
|
| IActiveMarkingList |
Represents a collection of ActiveMarking objects.
|
| IAddOnInstallationRecordList |
Represents a collection of AddOnInstallationRecord objects.
|
| IAddOnSet |
Represents a collection of AddOn objects.
|
| IAnnotationSet |
Represents a collection of Annotation objects.
|
| IAuditDefinitionList |
Represents a collection of IAuditDefinitionList objects.
Use this interface to set or get events that you want to audit on a class.
|
| IBinaryList |
Represents a List collection (ordered, non-unique) of byte (8-bit signed
Integer) array elements, each of which is intended to hold a binary value. To
create an instance of BinaryList, call CreateList on the
Factory.BinaryList class.
|
| IBooleanList |
Represents a collection of Boolean objects. To create an instance of
BooleanList, call CreateList on the Factory.BooleanList
class.
|
| IChoiceList |
Represents a collection of Choice objects. To create an instance of this object,
call Factory.Choice.CreateList().
|
| IChoiceListSet |
Represents a collection of ChoiceList objects.
|
| IClassDefinitionSet |
Represents a collection of objects, each of which is an instance of a ClassDefinition
class or one of its subclasses.
|
| IClassDescriptionSet |
Represents a collection of ClassDescription objects.
|
| IClassSubscriptionSet |
Represents a collection of IClassSubscription objects.
|
| IClassWorkflowSubscriptionSet |
Represents a collection of IClassWorkflowSubscription objects.
|
| ICmAbstractDependentList | |
| ICmAbstractPermissionList |
Represents a collection of ICmAbstractPermission objects.
|
| ICmAbstractSearchResultSet |
Represents a collection of ICmAbstractSearchResult objects.
|
| ICmAdvancedStorageAreaSet |
Represents a collection of ICmAdvancedStorageArea objects.
|
| ICmAuditDispositionPolicySet |
Represents a collection of ICmAuditDispositionPolicy objects.
You can retrieve ICmAuditDispositionPolicySet from the
AuditDispositionPolicies property of IObjectStore.
|
| ICmAuditProcessingBookmarkSet |
Represents a collection of ICmAuditProcessingBookmark objects.
You can retrieve ICmAuditProcessingBookmarkSet with the AuditProcessingBookmarks property
of IObjectStore.
|
| ICmBackgroundSearchSet |
Represents a collection of ICmBackgroundSearch objects.
|
| ICmChangePreprocessorActionSet |
Represents a collection of CmChangePreprocessorAction objects.
|
| ICmChangePreprocessorDefinitionList |
Represents a collection of CmChangePreprocessorDefinitionList objects.
|
| ICmConversionSettingsClassDefinitionSet |
This collection interface is not supported.
|
| ICmCredentialsManagerSet | |
| ICmDatabaseConnectionSet |
Represents a collection of ICmDatabaseConnection objects. A ICmDatabaseConnectionSet
is returned by the DatabaseConnections property of the IDomain object.
|
| ICmElasticSearchClusterSet | |
| ICmElasticSearchIndexList | |
| ICmEventExportStoreSet |
Represents a collection of ICmEventExportStore objects.
|
| ICmHoldableSet |
Represents a collection of ICmHoldable objects.
|
| ICmHoldRelationshipSet |
Represents a collection of ICmHoldRelationship objects.
|
| ICmIdentityRuleList | |
| ICmIndexDefinitionList |
Represents a collection of CmIndexDefinition objects.
|
| ICmIndexedColumnList |
Represents a collection of CmIndexedColumn objects that define the columns that comprise an index.
The order in which the CmIndexedColumn objects appear in the list reflect the order in which the columns
are defined in the index. At least one element is required in the list.
|
| ICmIndexPartitionConstraintList |
Represents a collection of CmIndexPartitionConstraint objects.
You can retrieve this collection with the IndexPartitionConstraints property of an ICmTextSearchIndex object.
|
| ICmIndexRequestSet |
Represents a collection of ICmIndexRequest objects.
|
| ICmJobSweepResultSet |
Represents a collection of ICmJobSweepResult objects.
|
| ICmLocalGroupMemberList | |
| ICMODApplicationGroupSet |
Represents a collection of CMODApplicationGroup objects.
|
| ICmPolicyControlledSweepSet |
Represents a collection of CmPolicyControlledSweep objects.
|
| ICmPolicySweepResultSet |
Represents a collection of ICmPolicySweepResult objects.
|
| ICmQueueSweepSet |
Represents a collection of ICmQueueSweep objects.
|
| ICmRecoveryItemSet |
Represents a collection of ICmRecoveryItem objects.
|
| ICmReplicaSynchronizationSiteSettingsList |
Represents a collection of ICmReplicaSynchronizationSiteSettings objects.
|
| ICmRoleAccessDefinitionList |
Represents a collection of ICmRoleAccessDefinition objects.
|
| ICmRoleClassDefinitionSet |
Represents a collection of ICmRoleClassDefinition objects.
|
| ICmRoleMemberList |
Represents a collection of ICmRoleMember objects.
|
| ICmStorageDeviceConnectionList |
Represents a collection of ICmStorageDeviceConnection objects.
One or more ICmStorageDeviceConnection objects are set on an
ICmAdvancedStorageArea.
|
| ICmSweepJobSet |
Represents a collection of CmSweepJob objects.
|
| ICmSweepPolicyRelationshipSet |
Represents a collection of CmSweepPolicyRelationship objects.
|
| ICmSweepPolicySet |
Represents a collection of CmSweepPolicy objects.
|
| ICmSweepRelationshipSet |
Represents a collection of ICmSweepRelationship objects.
|
| ICmSweepResultSet |
Represents a collection of ICmSweepResult objects.
|
| ICmSweepSet |
Represents a collection of CmSweep objects.
|
| ICmTaskRelationshipSet |
Represents a collection of ICmTaskRelationship objects.
A ICmTaskRelationshipSet is returned by Successors
or Predecessors of an ICmTask object.
|
| ICmTaskSet |
Represents a collection of ICmTask objects.
A ICmTaskSet is returned by IContainable.CoordinatedTasks.
|
| ICmTextIndexingPreprocessorDefinitionList |
This collection interface is not supported.
|
| ICmTextSearchAffinityGroupSet |
Represents a collection of ICmTextSearchAffinityGroup objects.
|
| ICmTextSearchIndexList |
Represents a collection of CmTextSearchIndex objects.
You can retrieve this collection with the TextSearchIndexes property of an ICmTextSearchIndexArea object.
|
| ICmTextSearchPartitionPropertyList |
Represents a collection of CmTextSearchPartitionProperty objects.
You can retrieve this collection with the PartitioningProperties property of an IObjectStore object.
|
| ICmTextSearchServerSet |
Represents a collection of CmTextSearchServer objects.
You can retrieve this collection with the TextSearchServers property of an IDomain object.
|
| ICmThumbnailSet |
Represents a collection of ICmThumbnail objects.
|
| ICmTimeslotList |
A list of ICmTimeslot objects, each specifying a text indexing or an audit disposition schedule.
You can set or get a ICmTimeslotList object on or from ICmTextSearchConfiguration
or ICmAuditingConfiguration.
|
| ICmTivoliManagementClassSet |
Represents a collection of CmTivoliManagementClass objects.
|
| IColumnDefinitionList |
Represents a collection of ColumnDefinition objects.
|
| IComponentRelationshipSet |
Represents a collection of ComponentRelationship objects.
|
| IContainableSet |
Represents a collection of Containable objects.
|
| IContainmentRelationshipSet |
Represents a collection of ContainmentRelationship objects.
|
| IContentCacheAreaSet |
Represents a collection of ContentCacheArea objects.
|
| IContentElementList |
Represents a collection of objects, each of which is either a ContentReference or a
ContentTransfer object. To create an instance of this object, call Factory.ContentElement.CreateList().
|
| IContentTransferList | Obsolete.
Represents a collection of ContentTransfer objects. To create an instance of this object,
call Factory.ContentTransfer.CreateList().
|
| IDateTimeList |
Represents a List collection (ordered, non-unique) of Date values.
To create an instance of DateTimeList, call CreateList on the
Factory.DateTimeList class.
|
| IDependentObjectList |
Represents a collection of dependent objects. You cannot create an instance of a
DependentObjectList. This object is instantiated as the return value from a
method call such as GetDependentObjectListValue on the IProperties
or IProperty interfaces, or FetchDependentObjectListValue
on the IPropertyDependentObjectList interface.
|
| IDirectoryConfigurationList |
Represents the collection of IDirectoryConfiguration objects defined for a given FileNet P8 domain.
To create a new, empty instance of this class, call Factory.DirectoryConfiguration.CreateList(). Then create one or more IDirectoryConfiguration objects, set their properties, and add the objects to this list. To associate the set of IDirectoryConfiguration objects to the FileNet P8 domain, set the DirectoryConfigurations property on the IDomain object. |
| IDiscretionaryPermissionList |
Represents a collection of DiscretionaryPermission objects.
|
| IDocumentClassificationActionSet |
Represents a collection of DocumentClassificationAction objects.
|
| IDocumentLifecycleActionSet |
Represents a collection of DocumentLifecycleAction objects.
|
| IDocumentLifecyclePolicySet |
Represents a collection of DocumentLifecyclePolicy objects.
|
| IDocumentSet |
Represents a collection of Document objects.
|
| IDocumentStateList |
Represents a collection of DocumentState objects. To create an instance of this object,
call Factory.DocumentState.CreateList().
|
| IEngineCollection | Provides functionality common to all collection objects. This interface
is the base interface for the collection class hierarchy.
A collection can be one of three types: a set, a list, or a row set. A set is a collection of independent objects, the elements of which are unordered and unique. Functionality common only to sets is defined in the IEngineSet interface. Sets can be enumerated a page at a time (instead of one object or one row at a time), and may not be directly updated. A list is a collection of dependent objects, the elements of which are ordered and need not be unique. A row set is a collection of rows (such as the result set returned from a query) and has the characteristics of a set-type collection. The name of a collection identifies its type. For example, a DocumentSet is a collection of Document objects, which are independent objects. A DependentObjectList is a collection of dependent objects. A RepositoryRowSet is a row set. This interface provides standard collection methods. |
| IEngineSet |
Defines collection functionality common only to sets. A set is a collection of
independent objects, the elements of which are unordered and unique. A set may
not be directly updated. You can enumerate a set one page at a time (instead
of one object or one row at a time).
|
| IEventActionSet |
Represents a collection of IEventAction objects.
|
| IEventSet |
Represents a collection of IEvent objects.
This is the base interface of several event collection subinterfaces.
|
| IExternalAliasList |
Represents a collection of ExternalAlias objects.
|
| IExternalClassAliasList |
Represents a collection of ExternalClassAlias objects. You can retrieve this collection with the
ExternalAliases property of a ReplicableClassDefinition object. To create an instance of this object,
call Factory.ExternalClassAlias.CreateList().
|
| IExternalClassDescriptionSet |
Represents a collection of ExternalClassDescription objects. You can retrieve this collection with the
ExternalClassDescriptions property of an ExternalRepository object.
|
| IExternalIdentityList |
Represents a collection of ExternalIdentity objects. You can retrieve this collection with the
ExternalReplicaIdentities property of a Replicable object.
|
| IExternalPropertyAliasList |
Represents a collection of ExternalPropertyAlias objects. You can retrieve this collection with the
ExternalAliases property of a PropertyDefinition object. To create an instance of this object,
call Factory.ExternalPropertyAlias.CreateList().
|
| IExternalPropertyDescriptionList |
Represents a collection of ExternalPropertyDescription objects. You can retrieve this collection with the
ExternalPropertyDescriptions property of an ExternalClassDescription object.
|
| IExternalRepositorySet |
Represents a collection of ExternalRepository objects. You can retrieve this collection with the
ExternalRepositories property of a Domain object.
|
| IFixedContentDeviceSet |
Represents a collection of fixed content device objects.
|
| IFloat64List |
Represents a List collection (ordered, non-unique) of Double
(64-bit floating point) values. To create an instance of Float64List,
call CreateList on the Factory.Float64List class.
|
| IFolderSet |
Represents a collection of Folder objects.
|
| IGroupSet |
Represents a collection of Group objects.
|
| IIdList |
Represents a collection of Id objects. To create an instance
of IdList, call CreateList on the Factory.IdList class.
|
| IImageServicesClassDescriptionList |
Represents a collection of ImageServicesClassDescription objects.
To create an instance of this object, call Factory.ImageServicesClassDescription.createList().
|
| IImageServicesPropertyDescriptionList |
Represents a collection of ImageServicesPropertyDescription objects.
To create an instance of this object, call Factory.ImageServicesPropertyDescription.createList().
|
| IIndependentObjectSet |
Represents a collection of independent objects. An instance of this collection
is created as a result of fetching objects from a Content Engine repository and
casting the returned objects to IndependentObjectSet.
|
| IIndexAreaSet |
Represents a collection of IndexArea objects.
|
| IIndexJobItemList |
Represents a collection of IndexJobItem objects.
|
| IInstanceSubscriptionSet |
Represents a collection of IInstanceSubscription objects.
|
| IInstanceWorkflowSubscriptionSet |
Represents a collection of IInstanceWorkflowSubscription objects.
|
| IInteger32List |
Represents a List collection (ordered, non-unique) of Integer
(32-bit signed Integer) values. To create an instance of Integer32List,
call CreateList on the Factory.Integer32List class.
|
| IIsolatedRegionSet |
Represents a collection of IsolatedRegion objects.
|
| ILinkSet |
Represents a collection of Link objects.
|
| ILocalizedStringList |
Represents a collection of LocalizedString objects.
|
| IMarkingList |
Represents a collection of Marking objects.
You can create a new, empty MarkingList by calling Factory.Marking.CreateList(). You can retrieve an existing MarkingList object by retrieving the Markings property of a MarkingSet object. |
| IMarkingSetSet |
Represents a collection of MarkingSet objects.
|
| IObjectStoreSet |
Represents a collection of ObjectStore objects.
|
| IPageEnumerator |
Provides paging functionality for sets of independent objects and repository rows.
Sets of independent objects and repository rows are divided into pages; each page is a number of collection elements (objects or rows) that represent a subset of the collection elements. You can enumerate a page at a time instead of one object or row at a time. As an example, if a page is defined as 10 elements, and the collection has a total of 22 elements, the first paging operation returns a page containing 10 elements, the second page returns the next 10 elements, and the third page returns the last 2 elements. This page enumeration is especially useful for interactive applications that display a page of information at a time. Each page enumerator is initially positioned before the first page of the set. The first call to the NextPage method moves the enumerator to the first page. The second call to NextPage moves the enumerator to the second page, and so on. The NextPage method returns True until the end of the set is NextPagereached. When the enumerator reaches the end of the set, it is positioned after the last page and NextPage returns False. The GetCurrentPage and GetElementCount methods throw an exception if the enumerator is positioned before the first page or after the last page, or between pages after a Reset(mark) operation. For proper positioning, you must call NextPage on a new enumerator and after a Reset operation. You may call the GetPageMark method at any time. Of these methods, only NextPage moves the position of the enumerator. The returned value of GetElementCount is always equal to GetCurrentPage().Length. Use GetElementCount to avoid copying the potentially large internal array just to get its length. You can also get the current page continuation state (that is, the page on which the enumerator will continue with the next call) and reset the enumerator back to a previous page of results. The saved position of the enumerator is called a "page mark". The GetPageMark method retrieves the current mark, and the Reset(mark) method resets the state of the enumerator to a previously saved mark. The Reset method positions the enumerator before the marked page; the NextPage method must be called to position the enumerator to the marked page. It is also possible to mark and reset to the position before the first page and the position after the last page. The Reset method (with no parameters) positions the enumerator before the first page of the collection. This is essentially the same as getting a new enumerator from the collection. You must then call the NextPage method to position the enumerator to the first page. The GetPageSize and SetPageSize methods allow you to query and adjust the internal paging size of the enumerator. The new size takes effect on the next fetch from the server. This is typically on the next call to NextPage. The actual size of each returned page may be smaller (including zero) or larger than the requested page size. The first page of a set may be pre-fetched from the server and cached in the client. All enumerators of a set with a pre-fetched first page may return the same first page. All enumerators fetch subsequent pages, if any, directly from the server. |
| IPageMark |
Identifies the page on which the next enumerate operation will be performed
when enumerating a collection.
|
| IPEConnectionPointSet |
Represents a collection of PEConnectionPoint objects.
|
| IPermissionDescriptionList |
Represents a collection of PermissionDescription objects.
|
| IPermissionList |
Represents a collection of Permission objects.
|
| IPropertyDefinitionList |
Represents a collection of objects, each of which is an instance of a PropertyDefinition
subclass (PropertyDefinitionBinary, PropertyDefinitionBoolean, and so on).
To create an instance of this object, call Factory.PropertyDefinition.CreateList().
|
| IPropertyDescriptionList |
Represents a collection of objects, each of which is an instance of a PropertyDescription
subclass (PropertyDescriptionBinary, PropertyDescriptionBoolean, and so on).
|
| IPropertyTemplateSet |
Represents a collection of objects, each of which is an instance of a PropertyTemplate
subclass (PropertyTemplateBinary, PropertyTemplateBoolean, and so on).
|
| IRealmSet |
Represents a collection of Realm objects.
|
| IReferentialContainmentRelationshipSet |
Represents a collection of ReferentialContainmentRelationship objects.
|
| IRelationshipSet |
Represents a collection of Relationship objects.
|
| IReplicableClassDefinitionSet |
Represents a collection of ReplicableClassDefinition objects.
|
| IReplicableSet |
Represents a collection of Replicable objects.
|
| IReplicationGroupSet |
Represents a collection of ReplicationGroup objects. You can retrieve this collection
with the ReplicationGroups property of a Domain object.
|
| IReplicationParticipantList |
Represents a collection of ReplicationParticipant objects. You can retrieve this collection with the
ReplicationParticipants property of a ReplicationGroup object. To create an instance of this object,
call Factory.ReplicationParticipant.CreateList().
|
| IRepositoryRowSet |
Represents a collection of repository rows returned from a query. The elements of
this collection are items that were requested in the query. The rows contain values
of varying type. For example, the query may request the name and ID of select
documents. In this example, each returned row contains a name value and an ID value.
|
| IRepositorySet |
Represents a collection of Repository objects.
|
| ISecurityPolicySet |
Represents a collection of SecurityPolicy objects.
|
| ISecurityPrincipalSet |
Represents a collection of SecurityPrincipal objects.
|
| ISecurityTemplateList |
Represents a collection of SecurityTemplate objects.
|
| IServerInstanceSet |
Represents a collection of ServerInstance objects.
|
| ISiteSet |
Represents a collection of Site objects.
|
| ISiteSettingsList |
Represents a collection of subclassed SiteSettings objects.
The subclass collections are validated to ensure all
instances contained in the collection are of the proper subclass of SiteSettings (that is, a subclass
corresponding to its parent fixed content device).
|
| IStorageAreaSet |
Represents a collection of database, file, and/or fixed storage area objects.
|
| IStoragePolicySet |
Represents a collection of StoragePolicy objects.
|
| IStoredSearchSet |
Represents a collection of StoredSearch objects.
|
| IStringList |
Represents a collection of String objects. To create an instance
of StringList, call CreateList on the Factory.StringList
class.
|
| ISubscribableClassDefinitionSet |
Represents a collection of SubscribableClassDefinition objects.
|
| ISubscribableSet |
Represents a collection of ISubscribable objects.
|
| ISubscribedEventList |
Represents a collection of ISubscribedEvent objects.
|
| ISubscriptionSet |
Represents a collection of ISubscription objects or
one of its subclasses. To return this object, use the Subscriptions property
on IObjectStore.
|
| ISubsystemConfigurationList |
Represents a collection of SubsystemConfiguration objects. The elements of this
collection are the configuration objects available on the objects of the server hierarchy (Domain,
Site, VirtualServer, and ServerInstance).
You can create a new, empty instance of this collection by calling CreateList() on a "host" Site, VirtualServer, or ServerInstance independent object. You can then add instances of SubsystemConfiguration objects to the collection. For Domain, the Content Engine server automatically generates SubsystemConfiguration instances and pre-fills the SubsystemConfigurationList property of the Domain object when the FileNet P8 domain is created. This pre-filled list cannot be modified (you cannot add or delete elements), although the objects within the list can be modified. You can retrieve a SubsystemConfigurationList from the "host" independent object via the object's SubsystemConfigurations property. |
| ITableDefinitionSet |
Represents a collection of TableDefinition objects.
|
| IUserSet |
Represents a collection of User objects.
|
| IVersionableSet |
Represents a collection of objects, each of which is instantiated from an IVersionable subinterface.
|
| IVirtualServerSet |
Represents a collection of VirtualServer objects.
|
| IWorkflowDefinitionSet |
Represents a collection of IWorkflowDefinition objects.
|
| IXMLPropertyMappingScriptSet |
Represents a collection of XMLPropertyMappingScript objects.
|
