com.filenet.api.collection
Interface EngineCollection
- All Superinterfaces:
- java.io.Serializable
- All Known Subinterfaces:
- AccessPermissionDescriptionList, AccessPermissionList, ActionConsumerSet, ActionSet, ActiveMarkingList, AddOnInstallationRecordList, AddOnSet, AnnotationSet, ApplicationSecurityTemplateList, AsyncProcessingConfigurationList, AsyncUpgradeQueueItemSet, AuditConfigurationEventSet, AuditDefinitionList, BinaryList, BooleanList, CancelCheckoutEventSet, CenteraFixedContentDeviceSet, CenteraSiteSettingsList, CFSImportAgentConfigurationList, CFSSiteSettingsList, ChangeClassEventSet, ChangeStateEventSet, CheckinEventSet, CheckoutEventSet, ChoiceList, ChoiceListSet, ClassDefinitionSet, ClassDescriptionSet, ClassifyCompleteEventSet, ClassSubscriptionSet, ClassWorkflowSubscriptionSet, CMODApplicationGroupSet, CMODFixedContentDeviceSet, CMODRepositorySet, CodeModuleSet, ColumnDefinitionList, ComponentRelationshipSet, ContainableSet, ContainmentRelationshipSet, ContentCacheAreaSet, ContentCacheConfigurationList, ContentConfigurationList, ContentElementList, ContentFederatingRepositorySet, ContentReferenceList, ContentTransferList, CreationEventSet, CustomEventSet, CustomObjectSet, DatabaseStorageAreaSet, DateTimeList, DeletionEventSet, DemoteVersionEventSet, DependentObjectList, DirectoryConfigurationAdamList, DirectoryConfigurationADList, DirectoryConfigurationCAList, DirectoryConfigurationIBMList, DirectoryConfigurationList, DirectoryConfigurationNovellList, DirectoryConfigurationSunOneList, DiscretionaryPermissionList, DITARenditionEngineConnectionSet, DocumentClassDefinitionSet, DocumentClassificationActionSet, DocumentClassificationQueueItemSet, DocumentLifecycleActionSet, DocumentLifecyclePolicySet, DocumentSet, DocumentStateList, DomainSet, DynamicReferentialContainmentRelationshipSet, EngineSet, EventActionSet, EventClassDefinitionSet, EventQueueItemSet, EventSet, ExternalAliasList, ExternalClassAliasList, ExternalClassDescriptionSet, ExternalIdentityList, ExternalParticipantList, ExternalPropertyAliasList, ExternalPropertyDescriptionList, ExternalRepositorySet, FileEventSet, FileStorageAreaSet, FixedContentDeviceSet, FixedStorageAreaSet, Float64List, FolderSet, FreezeEventSet, GenericFixedContentDeviceSet, GetContentEventSet, GetObjectEventSet, GroupSet, IdList, IICEFixedContentDeviceSet, ImageServicesClassDescriptionList, ImageServicesImportAgentConfigurationList, ImageServicesPropertyDescriptionList, ImageServicesRepositorySet, ImageServicesSiteSettingsList, IMFixedContentDeviceSet, IndependentObjectSet, IndexAreaSet, IndexJobClassItemList, IndexJobCollectionItemList, IndexJobItemList, IndexJobSet, IndexJobSingleItemList, InstanceSubscriptionSet, InstanceWorkflowSubscriptionSet, Integer32List, IsolatedRegionSet, LinkSet, LocalizedStringList, LockEventSet, MarkingList, MarkingSetSet, ObjectChangeEventSet, ObjectStoreParticipantList, ObjectStoreSet, PEConnectionPointSet, PermissionDescriptionList, PermissionList, PromoteVersionEventSet, PropertyDefinitionBinaryList, PropertyDefinitionBooleanList, PropertyDefinitionDateTimeList, PropertyDefinitionFloat64List, PropertyDefinitionIdList, PropertyDefinitionInteger32List, PropertyDefinitionList, PropertyDefinitionObjectList, PropertyDefinitionStringList, PropertyDescriptionBinaryList, PropertyDescriptionBooleanList, PropertyDescriptionDateTimeList, PropertyDescriptionFloat64List, PropertyDescriptionIdList, PropertyDescriptionInteger32List, PropertyDescriptionList, PropertyDescriptionObjectList, PropertyDescriptionStringList, PropertyTemplateBinarySet, PropertyTemplateBooleanSet, PropertyTemplateDateTimeSet, PropertyTemplateFloat64Set, PropertyTemplateIdSet, PropertyTemplateInteger32Set, PropertyTemplateObjectSet, PropertyTemplateSet, PropertyTemplateStringSet, PublishCompleteEventSet, PublishingConfigurationList, PublishRequestEventSet, PublishRequestSet, PublishStyleTemplateSet, PublishTemplateSet, QueryEventSet, QueueItemSet, RealmSet, ReferentialContainmentRelationshipSet, RelationshipSet, RenditionEngineConnectionSet, ReplicableClassDefinitionSet, ReplicableSet, ReplicationConfigurationList, ReplicationGroupSet, ReplicationJournalEntrySet, ReplicationParticipantList, RepositoryRowSet, RepositorySet, RetrievalEventSet, SecurityPolicySet, SecurityPrincipalSet, SecurityPropagationQueueItemSet, SecurityTemplateList, ServerCacheConfigurationList, ServerInstanceSet, SiteSet, SiteSettingsList, SnapLockFixedContentDeviceSet, StorageAreaSet, StoragePolicySet, StringList, SubscribableClassDefinitionSet, SubscribableSet, SubscribedEventList, SubscriptionSet, SubsystemConfigurationList, TableDefinitionSet, TakeFederatedOwnershipEventSet, TraceLoggingConfigurationList, UnfileEventSet, UnlockEventSet, UpdateEventSet, UpdateSecurityEventSet, UpgradeAddOnSet, UserSet, VerityCollectionList, VerityDomainConfigurationSet, VerityIndexAreaSet, VerityServerConfigurationList, VersionableClassDefinitionSet, VersionableSet, VersioningSecurityTemplateList, VersionSeriesSet, VirtualServerSet, WorkflowDefinitionSet, WorkflowEventActionSet, XMLPropertyMappingScriptSet
public interface EngineCollection
- extends java.io.Serializable
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 EngineSet
interface. Sets can be
iterated 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.
- See Also:
PageIterator
Method Summary |
boolean |
isEmpty()
Indicates whether the collection is empty. |
java.util.Iterator |
iterator()
Returns a Java Iterator object for iterating
the items in the collection. |
isEmpty
boolean isEmpty()
- Indicates whether the collection is empty.
This method may require a round trip to the server for unevaluated
sets (such as
IndependentObjectSet
and RepositoryRowSet
).
- Returns:
true
if the collection has no elements; otherwise,
returns false
.
iterator
java.util.Iterator iterator()
- Returns a Java
Iterator
object for iterating
the items in the collection. In the case of sets, paging is
performed transparently.
The returned Iterator
object's remove()
method throws an
UnsupportedOperationException
.
- Returns:
- An
Iterator
object.
© Copyright IBM Corporation 2006, 2008. All rights reserved.