Package com.filenet.api.collection

Provides type-safe interfaces related to collections of objects.

See: Description

Interface Summary

Interface	Description
AccessPermissionDescriptionList	Represents a collection of AccessPermissionDescription objects.
AccessPermissionList	Represents a collection of AccessPermission objects.
ActionConsumerSet	Represents a collection of ActionConsumer objects.
ActionSet	Represents a collection of Action objects.
ActiveMarkingList	Represents a collection of ActiveMarking objects.
AddOnInstallationRecordList	Represents a collection of AddOnInstallationRecord objects.
AddOnSet	Represents a collection of AddOn objects.
AnnotationSet	Represents a collection of Annotation objects.
AuditDefinitionList	Represents a collection of AuditDefinitionList objects.
BinaryList	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.
BooleanList	Represents a collection of Boolean objects.
ChoiceList	Represents a collection of Choice objects.
ChoiceListSet	Represents a collection of ChoiceList objects.
ClassDefinitionSet	Represents a collection of objects, each of which is an instance of a ClassDefinition class or one of its subclasses.
ClassDescriptionSet	Represents a collection of ClassDescription objects.
ClassSubscriptionSet	Represents a collection of ClassSubscription objects.
ClassWorkflowSubscriptionSet	Represents a collection of ClassWorkflowSubscription objects.
CmAbstractDependentList
CmAbstractPermissionList	Represents a collection of CmAbstractPermission objects.
CmAbstractSearchResultSet	Represents a collection of CmAbstractSearchResult objects.
CmAdvancedStorageAreaSet	Represents a collection of CmAdvancedStorageArea objects.
CmAuditDispositionPolicySet	Represents a collection of CmAuditDispositionPolicy objects.
CmAuditProcessingBookmarkSet	Represents a collection of CmAuditProcessingBookmark objects.
CmBackgroundSearchSet	Represents a collection of CmBackgroundSearch objects.
CmChangePreprocessorActionSet	Represents a collection of CmChangePreprocessorAction objects.
CmChangePreprocessorDefinitionList	Represents a collection of CmChangePreprocessorDefinitionList objects.
CmConversionSettingsClassDefinitionSet	This collection interface is not supported.
CmCredentialsManagerSet
CmDatabaseConnectionSet	Represents a collection of CmDatabaseConnection objects.
CmElasticSearchClusterSet
CmElasticSearchIndexList
CmEventExportStoreSet	Represents a collection of CmEventExportStore objects.
CmHoldableSet	Represents a collection of CmHoldable objects.
CmHoldRelationshipSet	Represents a collection of CmHoldRelationship objects.
CmIdentityRuleList
CmIndexDefinitionList	Represents a collection of CmIndexDefinition objects.
CmIndexedColumnList	Represents a collection of CmIndexedColumn objects that define the columns that comprise an index.
CmIndexPartitionConstraintList	Represents a collection of CmIndexPartitionConstraint objects.
CmIndexRequestSet	Represents a collection of CmIndexRequest objects.
CmJobSweepResultSet	Represents a collection of CmJobSweepResult objects.
CmLocalGroupMemberList
CMODApplicationGroupSet	Represents a collection of CMODApplicationGroup objects.
CmPolicyControlledSweepSet	Represents a collection of CmPolicyControlledSweep objects.
CmPolicySweepResultSet	Represents a collection of CmPolicySweepResult objects.
CmQueueSweepSet	Represents a collection of CmQueueSweep objects.
CmRecoveryItemSet	Represents a collection of CmRecoveryItem objects.
CmReplicaSynchronizationSiteSettingsList	Represents a collection of CmReplicaSynchronizationSiteSettings objects.
CmRoleAccessDefinitionList	Represents a collection of CmRoleAccessDefinition objects.
CmRoleClassDefinitionSet	Represents a collection of CmRoleClassDefinition objects.
CmRoleMemberList	Represents a collection of CmRoleMember objects.
CmStorageDeviceConnectionList	Represents a collection of CmStorageDeviceConnection objects.
CmSweepJobSet	Represents a collection of CmSweepJob objects.
CmSweepPolicyRelationshipSet	Represents a collection of CmSweepPolicyRelationship objects.
CmSweepPolicySet	Represents a collection of CmSweepPolicy objects.
CmSweepRelationshipSet	Represents a collection of CmSweepRelationship objects.
CmSweepResultSet	Represents a collection of CmSweepResult objects.
CmSweepSet	Represents a collection of CmSweep objects.
CmTaskRelationshipSet	Represents a collection of CmTaskRelationship objects.
CmTaskSet	Represents a collection of CmTask objects.
CmTextIndexingPreprocessorDefinitionList	This collection interface is not supported.
CmTextSearchAffinityGroupSet	Represents a collection of CmTextSearchAffinityGroup objects.
CmTextSearchIndexList	Represents a collection of CmTextSearchIndex objects.
CmTextSearchPartitionPropertyList	Represents a collection of CmTextSearchPartitionProperty objects.
CmTextSearchServerSet	Represents a collection of CmTextSearchServer objects.
CmThumbnailSet	Represents a collection of CmThumbnail objects.
CmTimeslotList	A list of CmTimeslot objects, each specifying a text indexing or an audit disposition schedule.
CmTivoliManagementClassSet	Represents a collection of CmTivoliManagementClass objects.
ColumnDefinitionList	Represents a collection of ColumnDefinition objects.
ComponentRelationshipSet	Represents a collection of ComponentRelationship objects.
ContainableSet	Represents a collection of Containable objects.
ContainmentRelationshipSet	Represents a collection of ContainmentRelationship objects.
ContentCacheAreaSet	Represents a collection of ContentCacheArea objects.
ContentElementList	Represents a collection of objects, each of which is either a ContentReference or a ContentTransfer object.
ContentTransferList	Deprecated As of release 5.0.0.
DateTimeList	Represents a List collection (ordered, non-unique) of Date values.
DependentObjectList	Represents a collection of dependent objects.
DirectoryConfigurationList	Represents the collection of DirectoryConfiguration objects defined for a given FileNet P8 domain.
DiscretionaryPermissionList	Represents a collection of DiscretionaryPermission objects.
DocumentClassificationActionSet	Represents a collection of DocumentClassificationAction objects.
DocumentLifecycleActionSet	Represents a collection of DocumentLifecycleAction objects.
DocumentLifecyclePolicySet	Represents a collection of DocumentLifecyclePolicy objects.
DocumentSet	Represents a collection of Document objects.
DocumentStateList	Represents a collection of DocumentState objects.
EngineCollection	Provides functionality common to all collection objects.
EngineSet	Defines collection functionality common only to sets.
EventActionSet	Represents a collection of EventAction objects.
EventSet	Represents a collection of Event objects.
ExternalAliasList	Represents a collection of ExternalAlias objects.
ExternalClassAliasList	Represents a collection of ExternalClassAlias objects.
ExternalClassDescriptionSet	Represents a collection of ExternalClassDescription objects.
ExternalIdentityList	Represents a collection of ExternalIdentity objects.
ExternalPropertyAliasList	Represents a collection of ExternalPropertyAlias objects.
ExternalPropertyDescriptionList	Represents a collection of ExternalPropertyDescription objects.
ExternalRepositorySet	Represents a collection of ExternalRepository objects.
FixedContentDeviceSet	Represents a collection of fixed content device objects.
Float64List	Represents a List collection (ordered, non-unique) of Double (64-bit floating point) values.
FolderSet	Represents a collection of Folder objects.
GroupSet	Represents a collection of Group objects.
IdList	Represents a collection of Id objects.
ImageServicesClassDescriptionList	Represents a collection of ImageServicesClassDescription objects.
ImageServicesPropertyDescriptionList	Represents a collection of ImageServicesPropertyDescription objects.
IndependentObjectSet	Represents a collection of independent objects.
IndexAreaSet	Represents a collection of IndexArea objects.
IndexJobItemList	Represents a collection of IndexJobItem objects.
InstanceSubscriptionSet	Represents a collection of InstanceSubscription objects.
InstanceWorkflowSubscriptionSet	Represents a collection of InstanceWorkflowSubscription objects.
Integer32List	Represents a List collection (ordered, non-unique) of Integer (32-bit signed integer) values.
IsolatedRegionSet	Represents a collection of IsolatedRegion objects.
LinkSet	Represents a collection of Link objects.
LocalizedStringList	Represents a collection of LocalizedString objects.
MarkingList	Represents a collection of Marking objects.
MarkingSetSet	Represents a collection of MarkingSet objects.
ObjectStoreSet	Represents a collection of ObjectStore objects.
PageIterator	Provides paging functionality for sets of independent objects and repository rows.
PageMark	Identifies the page on which the next iteration operation will be performed when iterating a collection.
PEConnectionPointSet	Represents a collection of PEConnectionPoint objects.
PermissionDescriptionList	Represents a collection of PermissionDescription objects.
PermissionList	Represents a collection of Permission objects.
PropertyDefinitionList	Represents a collection of objects, each of which is an instance of a PropertyDefinition subclass (PropertyDefinitionBinary, PropertyDefinitionBoolean, and so on).
PropertyDescriptionList	Represents a collection of objects, each of which is an instance of a PropertyDescription subclass (PropertyDescriptionBinary, PropertyDescriptionBoolean, and so on).
PropertyTemplateSet	Represents a collection of objects, each of which is an instance of a PropertyTemplate subclass (PropertyTemplateBinary, PropertyTemplateBoolean, and so on).
RealmSet	Represents a collection of Realm objects.
ReferentialContainmentRelationshipSet	Represents a collection of ReferentialContainmentRelationship objects.
RelationshipSet	Represents a collection of Relationship objects.
ReplicableClassDefinitionSet	Represents a collection of ReplicableClassDefinition objects.
ReplicableSet	Represents a collection of Replicable objects.
ReplicationGroupSet	Represents a collection of ReplicationGroup objects.
ReplicationParticipantList	Represents a collection of ReplicationParticipant objects.
RepositoryRowSet	Represents a collection of repository rows returned from a query.
RepositorySet	Represents a collection of Repository objects.
SecurityPolicySet	Represents a collection of SecurityPolicy objects.
SecurityPrincipalSet	Represents a collection of SecurityPrincipal objects.
SecurityTemplateList	Represents a collection of SecurityTemplate objects.
ServerInstanceSet	Represents a collection of ServerInstance objects.
SiteSet	Represents a collection of Site objects.
SiteSettingsList	Represents a collection of subclassed SiteSettings objects.
StorageAreaSet	Represents a collection of database, file, and/or fixed storage area objects.
StoragePolicySet	Represents a collection of StoragePolicy objects.
StoredSearchSet	Represents a collection of StoredSearch objects.
StringList	Represents a collection of String objects.
SubscribableClassDefinitionSet	Represents a collection of SubscribableClassDefinition objects.
SubscribableSet	Represents a collection of Subscribable objects.
SubscribedEventList	Represents a collection of SubscribedEvent objects.
SubscriptionSet	Represents a collection of Subscription objects or one of its subclasses.
SubsystemConfigurationList	Represents a collection of SubsystemConfiguration objects.
TableDefinitionSet	Represents a collection of TableDefinition objects.
UserSet	Represents a collection of User objects.
VersionableSet	Represents a collection of objects, each of which is instantiated from a Versionable subinterface.
VirtualServerSet	Represents a collection of VirtualServer objects.
WorkflowDefinitionSet	Represents a collection of WorkflowDefinition objects.
XMLPropertyMappingScriptSet	Represents a collection of XMLPropertyMappingScript objects.

Package com.filenet.api.collection Description

Provides type-safe interfaces related to collections of objects.

Collections with names ending in Set (such as DocumentSet) represent independent objects; names ending in List (such as PermissionList) 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 EngineCollection interface defines functionality common to all collections; EngineSet defines functionality common only to sets.