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

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.
ApplicationSecurityTemplateList	Deprecated As of release 5.0.0.
AsyncProcessingConfigurationList	Deprecated As of release 5.0.0.
AsyncUpgradeQueueItemSet	Deprecated As of release 5.0.0.
AuditConfigurationEventSet	Deprecated As of release 5.0.0.
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.
CancelCheckoutEventSet	Deprecated As of release 5.0.0.
CenteraFixedContentDeviceSet	Deprecated As of release 5.0.0.
CenteraSiteSettingsList	Deprecated As of release 5.0.0.
CFSImportAgentConfigurationList	Deprecated As of release 5.0.0.
CFSSiteSettingsList	Deprecated As of release 5.0.0.
ChangeClassEventSet	Deprecated As of release 5.0.0.
ChangeStateEventSet	Deprecated As of release 5.0.0.
CheckinEventSet	Deprecated As of release 5.0.0.
CheckoutEventSet	Deprecated As of release 5.0.0.
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.
ClassifyCompleteEventSet	Deprecated As of release 5.0.0.
ClassSubscriptionSet	Represents a collection of `ClassSubscription` objects.
ClassWorkflowSubscriptionSet	Represents a collection of `ClassWorkflowSubscription` 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.
CmDatabaseConnectionSet	Represents a collection of `CmDatabaseConnection` objects.
CmDirectoryConfigurationOIDList	Deprecated As of release 5.0.0.
CmEventExportStoreSet	Represents a collection of `CmEventExportStore` objects.
CmHoldableSet	Represents a collection of `CmHoldable` objects.
CmHoldRelationshipSet	Represents a collection of `CmHoldRelationship` objects.
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.
CMODApplicationGroupSet	Represents a collection of `CMODApplicationGroup` objects.
CMODFixedContentDeviceSet	Deprecated As of release 5.0.0.
CMODRepositorySet	Deprecated As of release 5.0.0.
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.
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.
CodeModuleSet	Deprecated As of release 5.0.0.
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.
ContentCacheConfigurationList	Deprecated As of release 5.0.0.
ContentConfigurationList	Deprecated As of release 5.0.0.
ContentElementList	Represents a collection of objects, each of which is either a `ContentReference` or a `ContentTransfer` object.
ContentFederatingRepositorySet	Deprecated As of release 5.0.0.
ContentReferenceList	Deprecated As of release 5.0.0.
ContentTransferList	Deprecated As of release 5.0.0.
CreationEventSet	Deprecated As of release 5.0.0.
CustomEventSet	Deprecated As of release 5.0.0.
CustomObjectSet	Deprecated As of release 5.0.0.
DatabaseStorageAreaSet	Deprecated As of release 5.0.0.
DateTimeList	Represents a `List` collection (ordered, non-unique) of `Date` values.
DeletionEventSet	Deprecated As of release 5.0.0.
DemoteVersionEventSet	Deprecated As of release 5.0.0.
DependentObjectList	Represents a collection of dependent objects.
DirectoryConfigurationAdamList	Deprecated As of release 5.0.0.
DirectoryConfigurationADList	Deprecated As of release 5.0.0.
DirectoryConfigurationCAList	Deprecated As of release 5.0.0.
DirectoryConfigurationIBMList	Deprecated As of release 5.0.0.
DirectoryConfigurationList	Represents the collection of `DirectoryConfiguration` objects defined for a given FileNet P8 domain.
DirectoryConfigurationNovellList	Deprecated As of release 5.0.0.
DirectoryConfigurationSunOneList	Deprecated As of release 5.0.0.
DiscretionaryPermissionList	Represents a collection of `DiscretionaryPermission` objects.
DITARenditionEngineConnectionSet	Represents a collection of `DITARenditionEngineConnection` objects.
DocumentClassDefinitionSet	Deprecated As of release 5.0.0.
DocumentClassificationActionSet	Represents a collection of `DocumentClassificationAction` objects.
DocumentClassificationQueueItemSet	Deprecated As of release 5.0.0.
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.
DomainSet	Deprecated As of release 5.0.0.
DynamicReferentialContainmentRelationshipSet	Deprecated As of release 5.0.0.
EngineCollection	Provides functionality common to all collection objects.
EngineSet	Defines collection functionality common only to sets.
EventActionSet	Represents a collection of EventAction objects.
EventClassDefinitionSet	Deprecated As of release 5.0.0.
EventQueueItemSet	Deprecated As of release 5.0.0.
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.
ExternalParticipantList	Deprecated As of release 5.0.0.
ExternalPropertyAliasList	Represents a collection of `ExternalPropertyAlias` objects.
ExternalPropertyDescriptionList	Represents a collection of `ExternalPropertyDescription` objects.
ExternalRepositorySet	Represents a collection of `ExternalRepository` objects.
FileEventSet	Deprecated As of release 5.0.0.
FileStorageAreaSet	Deprecated As of release 5.0.0.
FixedContentDeviceSet	Represents a collection of fixed content device objects.
FixedStorageAreaSet	Deprecated As of release 5.0.0.
Float64List	Represents a `List` collection (ordered, non-unique) of `Double` (64-bit floating point) values.
FolderSet	Represents a collection of `Folder` objects.
FreezeEventSet	Deprecated As of release 5.0.0.
GenericFixedContentDeviceSet	Deprecated As of release 5.0.0.
GetContentEventSet	Deprecated As of release 5.0.0.
GetObjectEventSet	Deprecated As of release 5.0.0.
GroupSet	Represents a collection of `Group` objects.
IdList	Represents a collection of `Id` objects.
IICEFixedContentDeviceSet	Deprecated As of release 5.0.0.
ImageServicesClassDescriptionList	Represents a collection of `ImageServicesClassDescription` objects.
ImageServicesImportAgentConfigurationList	Deprecated As of release 5.0.0.
ImageServicesPropertyDescriptionList	Represents a collection of `ImageServicesPropertyDescription` objects.
ImageServicesRepositorySet	Deprecated As of release 5.0.0.
ImageServicesSiteSettingsList	Deprecated As of release 5.0.0.
IMFixedContentDeviceSet	Deprecated As of release 5.0.0.
IndependentObjectSet	Represents a collection of independent objects.
IndexAreaSet	Represents a collection of `IndexArea` objects.
IndexJobClassItemList	Deprecated As of release 5.0.0.
IndexJobCollectionItemList	Deprecated As of release 5.0.0.
IndexJobItemList	Represents a collection of `IndexJobItem` objects.
IndexJobSet	Deprecated As of release 5.0.0.
IndexJobSingleItemList	Deprecated As of release 5.0.0.
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.
LockEventSet	Deprecated As of release 5.0.0.
MarkingList	Represents a collection of `Marking` objects.
MarkingSetSet	Represents a collection of `MarkingSet` objects.
ObjectChangeEventSet	Deprecated As of release 5.0.0.
ObjectStoreParticipantList	Deprecated As of release 5.0.0.
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.
PromoteVersionEventSet	Deprecated As of release 5.0.0.
PropertyDefinitionBinaryList	Deprecated As of release 5.0.0.
PropertyDefinitionBooleanList	Deprecated As of release 5.0.0.
PropertyDefinitionDateTimeList	Deprecated As of release 5.0.0.
PropertyDefinitionFloat64List	Deprecated As of release 5.0.0.
PropertyDefinitionIdList	Deprecated As of release 5.0.0.
PropertyDefinitionInteger32List	Deprecated As of release 5.0.0.
PropertyDefinitionList	Represents a collection of objects, each of which is an instance of a `PropertyDefinition` subclass (`PropertyDefinitionBinary`, `PropertyDefinitionBoolean`, and so on).
PropertyDefinitionObjectList	Deprecated As of release 5.0.0.
PropertyDefinitionStringList	Deprecated As of release 5.0.0.
PropertyDescriptionBinaryList	Deprecated As of release 5.0.0.
PropertyDescriptionBooleanList	Deprecated As of release 5.0.0.
PropertyDescriptionDateTimeList	Deprecated As of release 5.0.0.
PropertyDescriptionFloat64List	Deprecated As of release 5.0.0.
PropertyDescriptionIdList	Deprecated As of release 5.0.0.
PropertyDescriptionInteger32List	Deprecated As of release 5.0.0.
PropertyDescriptionList	Represents a collection of objects, each of which is an instance of a `PropertyDescription` subclass (`PropertyDescriptionBinary`, `PropertyDescriptionBoolean`, and so on).
PropertyDescriptionObjectList	Deprecated As of release 5.0.0.
PropertyDescriptionStringList	Deprecated As of release 5.0.0.
PropertyTemplateBinarySet	Deprecated As of release 5.0.0.
PropertyTemplateBooleanSet	Deprecated As of release 5.0.0.
PropertyTemplateDateTimeSet	Deprecated As of release 5.0.0.
PropertyTemplateFloat64Set	Deprecated As of release 5.0.0.
PropertyTemplateIdSet	Deprecated As of release 5.0.0.
PropertyTemplateInteger32Set	Deprecated As of release 5.0.0.
PropertyTemplateObjectSet	Deprecated As of release 5.0.0.
PropertyTemplateSet	Represents a collection of objects, each of which is an instance of a `PropertyTemplate` subclass (`PropertyTemplateBinary`, `PropertyTemplateBoolean`, and so on).
PropertyTemplateStringSet	Deprecated As of release 5.0.0.
PublishCompleteEventSet	Deprecated As of release 5.0.0.
PublishingConfigurationList	Deprecated As of release 5.0.0.
PublishRequestEventSet	Deprecated As of release 5.0.0.
PublishRequestSet	Deprecated As of release 5.0.0.
PublishStyleTemplateSet	Deprecated As of release 5.0.0.
PublishTemplateSet	Deprecated As of release 5.0.0.
QueryEventSet	Deprecated As of release 5.0.0.
QueueItemSet	Deprecated As of release 5.0.0.
RealmSet	Represents a collection of `Realm` objects.
ReferentialContainmentRelationshipSet	Represents a collection of `ReferentialContainmentRelationship` objects.
RelationshipSet	Represents a collection of `Relationship` objects.
RenditionEngineConnectionSet	Represents a collection of `RenditionEngineConnection` objects.
ReplicableClassDefinitionSet	Represents a collection of `ReplicableClassDefinition` objects.
ReplicableSet	Represents a collection of `Replicable` objects.
ReplicationConfigurationList	Deprecated As of release 5.0.0.
ReplicationGroupSet	Represents a collection of `ReplicationGroup` objects.
ReplicationJournalEntrySet	Deprecated As of release 5.0.0
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.
RetrievalEventSet	Deprecated As of release 5.0.0.
SecurityPolicySet	Represents a collection of `SecurityPolicy` objects.
SecurityPrincipalSet	Represents a collection of `SecurityPrincipal` objects.
SecurityPropagationQueueItemSet	Deprecated As of release 5.0.0.
SecurityTemplateList	Represents a collection of `SecurityTemplate` objects.
ServerCacheConfigurationList	Deprecated As of release 5.0.0.
ServerInstanceSet	Represents a collection of `ServerInstance` objects.
SiteSet	Represents a collection of `Site` objects.
SiteSettingsList	Represents a collection of subclassed `SiteSettings` objects.
SnapLockFixedContentDeviceSet	Deprecated As of release 5.0.0.
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.
TakeFederatedOwnershipEventSet	Deprecated As of release 5.0.0.
TivoliFixedContentDeviceSet	Deprecated As of release 5.0.0.
TraceLoggingConfigurationList	Deprecated As of release 5.0.0.
UnfileEventSet	Deprecated As of release 5.0.0.
UnlockEventSet	Deprecated As of release 5.0.0.
UpdateEventSet	Deprecated As of release 5.0.0.
UpdateSecurityEventSet	Deprecated As of release 5.0.0.
UpgradeAddOnSet	Deprecated As of release 5.0.0.
UserSet	Represents a collection of `User` objects.
VerityCollectionList	Deprecated As of release 5.2.0.
VerityDomainConfigurationSet	Deprecated As of release 5.2.0.
VerityIndexAreaSet	Deprecated As of release 5.0.0.
VerityServerConfigurationList	Deprecated As of release 5.0.0.
VersionableClassDefinitionSet	Deprecated As of release 5.0.0.
VersionableSet	Represents a collection of objects, each of which is instantiated from a `Versionable` subinterface.
VersioningSecurityTemplateList	Deprecated As of release 5.0.0.
VersionSeriesSet	Deprecated As of release 5.0.0.
VirtualServerSet	Represents a collection of `VirtualServer` objects.
WorkflowDefinitionSet	Represents a collection of `WorkflowDefinition` objects.
WorkflowEventActionSet	Deprecated As of release 5.0.0.
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.