Package com.filenet.api.collection

Provides type-safe interfaces related to collections of objects.

See:
          Description

Interface Summary
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 Represents a collection of ApplicationSecurityTemplate objects.
AsyncProcessingConfigurationList Represents a collection of AsyncProcessingConfiguration objects.
AsyncUpgradeQueueItemSet For internal use only.
AuditConfigurationEventSet Represents a collection of AuditConfigurationEvent 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.
CancelCheckoutEventSet Represents a collection of CancelCheckoutEvent objects.
CenteraFixedContentDeviceSet Represents a collection of CenteraFixedContentDevice objects.
CenteraSiteSettingsList Represents a collection of CenteraSiteSettings objects.
CFSImportAgentConfigurationList Represents a collection of CFSImportAgentConfiguration objects.
CFSSiteSettingsList Represents a collection of CFSSiteSettings objects.
ChangeClassEventSet Represents a collection of ChangeClassEvent objects.
ChangeStateEventSet Represents a collection of ChangeStateEventSet objects.
CheckinEventSet Represents a collection of CheckinEvent objects.
CheckoutEventSet Represents a collection of CheckoutEvent 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.
ClassifyCompleteEventSet Represents a collection of ClassifyCompleteEventSet objects.
ClassSubscriptionSet Represents a collection of ClassSubscription objects.
ClassWorkflowSubscriptionSet Represents a collection of ClassWorkflowSubscription objects.
CMODApplicationGroupSet Represents a collection of CMODApplicationGroup objects.
CMODFixedContentDeviceSet Represents a collection of CMODFixedContentDevice objects.
CMODRepositorySet Represents a collection of CMODRepository objects.
CodeModuleSet Represents a collection of CodeModule 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.
ContentCacheConfigurationList Represents a collection of ContentCacheConfiguration objects.
ContentConfigurationList Represents a collection of ContentConfiguration objects.
ContentElementList Represents a collection of objects, each of which is either a ContentReference or a ContentTransfer object.
ContentFederatingRepositorySet Represents a collection of ContentFederatingRepository objects.
ContentReferenceList Represents a collection of ContentReference objects.
ContentTransferList Represents a collection of ContentTransfer objects.
CreationEventSet Represents a collection of CreationEvent objects.
CustomEventSet Represents a collection of CustomEvent objects.
CustomObjectSet Represents a collection of CustomObject objects.
DatabaseStorageAreaSet Represents a collection of DatabaseStorageArea objects.
DateTimeList Represents a List collection (ordered, non-unique) of Date values.
DeletionEventSet Represents a collection of DeletionEvent objects.
DemoteVersionEventSet Represents a collection of DemoteVersionEvent objects.
DependentObjectList Represents a collection of dependent objects.
DirectoryConfigurationAdamList Contains the group of DirectoryConfigurationAdam objects defined for a given FileNet P8 domain.
DirectoryConfigurationADList Contains the group of DirectoryConfigurationAD objects defined for a given FileNet P8 domain.
DirectoryConfigurationCAList This interface is not supported.
DirectoryConfigurationIBMList Contains the group of DirectoryConfigurationIBM objects defined for a given FileNet P8 domain.
DirectoryConfigurationList Specifies the collection of DirectoryConfiguration objects defined for a given FileNet P8 domain.
DirectoryConfigurationNovellList Contains the group of DirectoryConfigurationNovell objects defined for a given FileNet P8 domain.
DirectoryConfigurationSunOneList Contains the group of DirectoryConfigurationSunOne objects defined for a given FileNet P8 domain.
DiscretionaryPermissionList Represents a collection of DiscretionaryPermission objects.
DITARenditionEngineConnectionSet Represents a collection of DITARenditionEngineConnection objects.
DocumentClassDefinitionSet Represents a collection of DocumentClassDefinition objects.
DocumentClassificationActionSet Represents a collection of DocumentClassificationAction objects.
DocumentClassificationQueueItemSet Represents a collection of DocumentClassificationQueueItem 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.
DomainSet Represents a collection of Domain objects.
DynamicReferentialContainmentRelationshipSet Represents a collection of DynamicReferentialContainmentRelationship objects.
EngineCollection Provides functionality common to all collection objects.
EngineSet Defines collection functionality common only to sets.
EventActionSet Represents a collection of EventAction objects.
EventClassDefinitionSet Represents a collection of EventClassDefinition objects.
EventQueueItemSet Represents a collection of EventQueueItem 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.
ExternalParticipantList This interface is not supported.
ExternalPropertyAliasList Represents a collection of ExternalPropertyAlias objects.
ExternalPropertyDescriptionList Represents a collection of ExternalPropertyDescription objects.
ExternalRepositorySet Represents a collection of ExternalRepository objects.
FileEventSet Represents a collection of FileEvent objects.
FileStorageAreaSet Represents a collection of FileStorageArea objects.
FixedContentDeviceSet Represents a collection of fixed content device objects.
FixedStorageAreaSet Represents a collection of FixedStorageArea objects.
Float64List Represents a List collection (ordered, non-unique) of Double (64-bit floating point) values.
FolderSet Represents a collection of Folder objects.
FreezeEventSet Represents a collection of FreezeEvent objects.
GenericFixedContentDeviceSet Represents a collection of GenericFixedContentDevice objects.
GetContentEventSet Represents a collection of GetContentEvent objects.
GetObjectEventSet Represents a collection of GetObjectEvent objects.
GroupSet Represents a collection of Group objects.
IdList Represents a collection of Id objects.
IICEFixedContentDeviceSet Represents a collection of IICEFixedContentDevice objects.
ImageServicesClassDescriptionList Represents a collection of ImageServicesClassDescription objects.
ImageServicesImportAgentConfigurationList Represents a collection of ImageServicesImportAgentConfiguration objects.
ImageServicesPropertyDescriptionList Represents a collection of ImageServicesPropertyDescription objects.
ImageServicesRepositorySet Represents a collection of ImageServicesRepository objects.
ImageServicesSiteSettingsList Represents a collection of ImageServicesSiteSettings objects.
IMFixedContentDeviceSet Represents a collection of IMFixedContentDevice objects.
IndependentObjectSet Represents a collection of independent objects.
IndexAreaSet Represents a collection of IndexArea objects.
IndexJobClassItemList Represents a collection of IndexJobClassItem objects.
IndexJobCollectionItemList Represents a collection of IndexJobCollectionItem objects.
IndexJobItemList Represents a collection of IndexJobItem objects.
IndexJobSet Represents a collection of IndexJob objects.
IndexJobSingleItemList Represents a collection of IndexJobSingleItem 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.
LockEventSet Represents a collection of LockEvent objects.
MarkingList Represents a collection of Marking objects.
MarkingSetSet Represents a collection of MarkingSet objects.
ObjectChangeEventSet Base interface that represents a collection of ObjectChangeEvent objects.
ObjectStoreParticipantList Represents a collection of ObjectStoreParticipant 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.
PromoteVersionEventSet Represents a collection of PromoteVersionEventSet objects.
PropertyDefinitionBinaryList Represents a collection of PropertyDefinitionBinary objects.
PropertyDefinitionBooleanList Represents a collection of PropertyDefinitionBoolean objects.
PropertyDefinitionDateTimeList Represents a collection of PropertyDefinitionDateTime objects.
PropertyDefinitionFloat64List Represents a collection of PropertyDefinitionFloat64 objects.
PropertyDefinitionIdList Represents a collection of PropertyDefinitionId objects.
PropertyDefinitionInteger32List Represents a collection of PropertyDefinitionInteger32 objects.
PropertyDefinitionList Represents a collection of objects, each of which is an instance of a PropertyDefinition subclass (PropertyDefinitionBinary, PropertyDefinitionBoolean, and so on).
PropertyDefinitionObjectList Represents a collection of PropertyDefinitionObject objects.
PropertyDefinitionStringList Represents a collection of PropertyDefinitionString objects.
PropertyDescriptionBinaryList Represents a collection of PropertyDescriptionBinary objects.
PropertyDescriptionBooleanList Represents a collection of PropertyDescriptionBoolean objects.
PropertyDescriptionDateTimeList Represents a collection of PropertyDescriptionDateTime objects.
PropertyDescriptionFloat64List Represents a collection of PropertyDescriptionFloat64 objects.
PropertyDescriptionIdList Represents a collection of PropertyDescriptionId objects.
PropertyDescriptionInteger32List Represents a collection of PropertyDescriptionInteger32 objects.
PropertyDescriptionList Represents a collection of objects, each of which is an instance of a PropertyDescription subclass (PropertyDescriptionBinary, PropertyDescriptionBoolean, and so on).
PropertyDescriptionObjectList Represents a collection of PropertyDescriptionObject objects.
PropertyDescriptionStringList Represents a collection of PropertyDescriptionString objects.
PropertyTemplateBinarySet Represents a collection of PropertyTemplateBinary objects.
PropertyTemplateBooleanSet Represents a collection of PropertyTemplateBoolean objects.
PropertyTemplateDateTimeSet Represents a collection of PropertyTemplateDateTime objects.
PropertyTemplateFloat64Set Represents a collection of PropertyTemplateFloat64 objects.
PropertyTemplateIdSet Represents a collection of PropertyTemplateId objects.
PropertyTemplateInteger32Set Represents a collection of PropertyTemplateInteger32 objects.
PropertyTemplateObjectSet Represents a collection of PropertyTemplateObject objects.
PropertyTemplateSet Represents a collection of objects, each of which is an instance of a PropertyTemplate subclass (PropertyTemplateBinary, PropertyTemplateBoolean, and so on).
PropertyTemplateStringSet Represents a collection of PropertyTemplateString objects.
PublishCompleteEventSet Represents a collection of PublishCompleteEvent objects.
PublishingConfigurationList Represents a collection of PublishingConfiguration objects.
PublishRequestEventSet Represents a collection of PublishRequestEvent objects.
PublishRequestSet Represents a collection of PublishRequest objects.
PublishStyleTemplateSet Represents a collection of PublishStyleTemplate objects.
PublishTemplateSet Represents a collection of PublishTemplate objects.
QueryEventSet Represents a collection of QueryEvent objects.
QueueItemSet Represents a collection of QueueItem objects.
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 Represents a collection of ReplicationConfiguration objects.
ReplicationGroupSet This interface is not supported.
ReplicationJournalEntrySet Represents a collection of ReplicationJournalEntry 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.
RetrievalEventSet Represents a collection of RetrievalEvent objects.
SecurityPolicySet Represents a collection of SecurityPolicy objects.
SecurityPrincipalSet Represents a collection of SecurityPrincipal objects.
SecurityPropagationQueueItemSet Represents a collection of SecurityPropagationQueueItem objects.
SecurityTemplateList Represents a collection of SecurityTemplate objects.
ServerCacheConfigurationList Represents a collection of ServerCacheConfiguration objects.
ServerInstanceSet Represents a collection of ServerInstance objects.
SiteSet Represents a collection of Site objects.
SiteSettingsList Represents a collection of subclassed SiteSettings objects.
SnapLockFixedContentDeviceSet Represents a collection of SnapLockFixedContentDevice objects.
StorageAreaSet Represents a collection of database, file, and/or fixed storage area objects.
StoragePolicySet Represents a collection of StoragePolicy 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 Represents a collection of TakeFederatedOwnershipEvent objects.
TraceLoggingConfigurationList Represents a collection of TraceLoggingConfiguration objects.
UnfileEventSet Represents a collection of UnfileEvent objects.
UnlockEventSet Represents a collection of UnlockEvent objects.
UpdateEventSet Represents a collection of UpdateEvent objects.
UpdateSecurityEventSet Represents a collection of UpdateSecurityEvent objects.
UpgradeAddOnSet Represents a collection of UpgradeAddOn objects.
UserSet Represents a collection of User objects.
VerityCollectionList Represents a collection of VerityCollection objects.
VerityDomainConfigurationSet Represents a collection of VerityDomainConfiguration objects.
VerityIndexAreaSet Represents a collection of VerityIndexArea objects.
VerityServerConfigurationList Represents a collection of VerityServerConfiguration objects.
VersionableClassDefinitionSet Represents a collection of VersionableClassDefinition objects.
VersionableSet Represents a collection of objects, each of which is instantiated from a Versionable subinterface.
VersioningSecurityTemplateList Represents a collection of VersioningSecurityTemplate objects.
VersionSeriesSet Represents a collection of VersionSeries objects.
VirtualServerSet Represents a collection of VirtualServer objects.
WorkflowDefinitionSet Represents a collection of WorkflowDefinition objects.
WorkflowEventActionSet Represents a collection of WorkflowEventAction 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.



© Copyright IBM Corporation 2006, 2008. All rights reserved.