-
Packages that use RepositoryObject Package Description com.filenet.api.admin Provides classes and interfaces that are used in the administration of a FileNet P8 Content Engine Server.com.filenet.api.core Provides classes and interfaces that are related to the core business objects of the API, such asEntireNetwork,Domain,Document,Folder, and so on.com.filenet.api.events Provides interfaces that represent events triggered on Content Engine objects, as well as interfaces that allow you to extend Content Engine functionality and invoke it through the event mechanism.com.filenet.api.query Provides classes related to constructing and performing Content Engine searches.com.filenet.api.replication Provides interfaces for defining objects that can be replicated and external repositories that are capable of federating content.com.filenet.api.security Provides interfaces related to authentication, authorization, and user- and group-specific data.com.filenet.api.sweep Provides classes and interfaces for the sweep framework, a background service that visits a specified class and processes the instances that meet a specified criteria.com.filenet.api.util Provides utility classes and interfaces. -
-
Uses of RepositoryObject in com.filenet.api.admin
Subinterfaces of RepositoryObject in com.filenet.api.admin Modifier and Type Interface and Description interfaceAddOnInstallationRecordRepresents a record that contains information pertaining to the installation of an add-on.interfaceAsyncUpgradeQueueItemFor internal use only.interfaceAuditDefinitionRepresents a definition that specifies audit-event parameters.interfaceChoiceRepresents a single choice item in a choice list that can be assigned to a property, or represents a group node for a nested collection of choice items within a choice list.interfaceChoiceListRepresents a choice list in an object store.interfaceClassDefinitionRepresents the class definition (mutable class metadata) of non-versionable, non-subscribable classes.interfaceCmAbstractQueueEntryCustomizable base for classes of objects that can be processed by a queue sweep.interfaceCmAdvancedStorageAreaA storage area supporting these underlying advanced storage devices: OpenStack and S3 cloud storage and file system storage.interfaceCmAuditDispositionPolicyDeprecated.As of release 5.5.6. A Disposal Policy targeting the Event class should be used instead.interfaceCmAuditProcessingBookmarkRepresents a leave-off point in the audit log (Event table), which indicates the last record processed by an audit processing client, such as an analytics or case history application.interfaceCmAzureBlobStorageDeviceinterfaceCmChangePreprocessorDefinitionAssociates aCmChangePreprocessorActionobject with a class definition.interfaceCmContentConversionActionThis class is not supported.interfaceCmContentConversionSettingsThis class is not supported.interfaceCmContentValidationActioninterfaceCmConversionSettingsClassDefinitionThis interface is not supported.interfaceCmCustomStorageDeviceThis class is not supported.interfaceCmDependentClassDefinitioninterfaceCmElasticSearchIndexinterfaceCmElasticSearchIndexAreainterfaceCmFileSystemStorageDeviceRepresents an advanced storage device that stores content in a file system.interfaceCmHoldRepresents a hold on an object of typeCmHoldable, preventing that object from being deleted for an indefinite period of time, until the hold is explicitly removed.interfaceCmHoldRelationshipDefines a hold-held relationship betweenCmHold(hold object) andCmHoldableobject (the held object).interfaceCmIndexDefinitionDefines a database table's index.interfaceCmIndexedColumnDefines a column that forms part of a database index, and the manner in which the column participates in the index.interfaceCmIndexJobResyncItemRepresents an index job that resynchronizes a full-text index with the data in an object store database.interfaceCmIndexPartitionConstraintRepresents an index partition constraint associated with an IBM® Content Search Services index.interfaceCmIndexPartitionConstraintDateRepresents the date range of a date partition constraint for an IBM® Content Search Services index.interfaceCmIndexPartitionConstraintStringRepresents the name and value of a string partition constraint for an IBM® Content Search Services index.interfaceCmIndexRequestRepresents the base class for index requests.interfaceCmOpenStackStorageDeviceRepresents an advanced storage device available through an OpenStack-conformant object storage service.interfaceCmQueueEntryClassDefinitionMutable metadata class defining a subclass ofCmAbstractQueueEntry.interfaceCmReindexSweepJobinterfaceCmRoleAccessDefinitionDefines the access control applied to a particular class by the role.interfaceCmRoleClassDefinitionMutable metadata class defining a subclass ofCmRole.interfaceCmRoleMembershipActionDefines an action that evaluates user membership in dynamic roles.interfaceCmS3StorageDeviceRepresents an advanced storage device available through an S3-conformant object storage service.interfaceCmSearchFunctionDefinitionDefines a custom SQL search function that can be invoked during a background search.interfaceCmSecuredStorageDeviceThis class is not supported.interfaceCmStorageDeviceAbstract base class for objects that represent different types of advanced storage devices.interfaceCmStorageDeviceConnectionAn object defining a connection between an advanced storage area and an advanced storage device.interfaceCmTextExtractionSettingsThis class is not supported.interfaceCmTextIndexingPreprocessorActionThis interface is not supported.interfaceCmTextIndexingPreprocessorDefinitionThis interface is not supported.interfaceCmTextSearchIndexRepresents an IBM® Content Search Services index, which holds the full-text indexing information that is created, updated, and searched by an IBM Content Search Services server.interfaceCmTextSearchIndexAreaRepresents the configuration of an IBM® Content Search Services index area.interfaceCmTextSearchIndexRequestRepresents an index request generated for a text search-enabled object for IBM® Content Search Services.interfaceCodeModuleRepresents a Java action handler to be stored on the Content Engine.interfaceColumnDefinitionRepresents the description of a column in a Content Engine database table.interfaceDatabaseStorageAreaRepresents a storage area for content elements stored in the database.interfaceDocumentClassDefinitionRepresents the class definition (mutable class metadata) of theDocumentclass and its subclasses.interfaceDocumentClassificationQueueItemRepresents a pending (queued) document auto-classification request.interfaceEventClassDefinitionRepresents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited.interfaceEventQueueItemRepresents a pending (queued) execution of an asynchronous event action, or an asynchronous event queue item that remains unprocessed because its retry count is zero.interfaceFileStorageAreaRepresents a storage area for content elements stored in the file system.interfaceFixedStorageAreaRepresents a storage area for content elements stored in a fixed content device.interfaceIndexAreaRepresents the disk storage location and data necessary to perform full-text indexing for content-based retrieval.interfaceIndexJobInitiates and tracks the status of a full-text indexing operation.interfaceIndexJobClassItemIdentifies the class to be full-text indexed.interfaceIndexJobCollectionItemIdentifies an IBM® Content Search Services index to be full-text indexed.interfaceIndexJobItemIndicates a particular item that is being full text indexed.interfaceIndexJobSingleItemIdentifies an object to be full-text indexed.interfaceLocalizedStringProvides a means of support for locale-specific display names and descriptive text used by a class definition or property template.interfacePropertyDefinitionRepresents the base class for all property definition classes.interfacePropertyDefinitionBinaryRepresents the definition of a property that holds a binary value.interfacePropertyDefinitionBooleanRepresents the definition of a property that holds a Boolean value.interfacePropertyDefinitionDateTimeRepresents the definition of a property that holds a DateTime value.interfacePropertyDefinitionFloat64Represents the definition of a property that holds a Double (Float64) value.interfacePropertyDefinitionIdRepresents the definition of a property that holds a GUID string value.interfacePropertyDefinitionInteger32Represents the definition of a property that holds an integer value.interfacePropertyDefinitionObjectRepresents the definition of a property that holds a Content Engine object value.interfacePropertyDefinitionStringRepresents the definition of a property that holds a string value.interfacePropertyTemplateRepresents the base class for all property template classes.interfacePropertyTemplateBinaryRepresents a property template for creatingPropertyDefinitionBinaryobjects, which you can add to class definitions to create user-defined properties for holding binary values.interfacePropertyTemplateBooleanRepresents a property template for creatingPropertyDefinitionBooleanobjects, which you can add to class definitions to create user-defined properties for holding Boolean values.interfacePropertyTemplateDateTimeRepresents a property template for creatingPropertyDefinitionDateTimeobjects, which you can add to class definitions to create user-defined properties for holding DateTime values.interfacePropertyTemplateFloat64Represents a property template for creatingPropertyDefinitionFloat64objects, which you can add to class definitions to create user-defined properties for holding Double (Float64) values.interfacePropertyTemplateIdRepresents a property template for creatingPropertyDefinitionIdobjects, which you can add to class definitions to create user-defined properties for holding GUID string values.interfacePropertyTemplateInteger32Represents a property template for creatingPropertyDefinitionInteger32objects, which you can add to class definitions to create user-defined properties for holding integer values.interfacePropertyTemplateObjectRepresents a property template for creatingPropertyDefinitionObjectobjects, which you can add to class definitions to create user-defined properties for holding Content Engine object values.interfacePropertyTemplateStringRepresents a property template for creatingPropertyDefinitionStringobjects, which you can add to class definitions to create user-defined properties for holding string values.interfaceQueueItemThis class is the base class for all queue-related classes.interfaceReplicableClassDefinitionRepresents the class definition (mutable class metadata) of classes of which an object instance can be replicated.interfaceStorageAreaRepresents the physical storage location where content will be stored.interfaceStoragePolicyRepresents a subset of available storage areas that are deemed equivalent based on common, user-specified criteria.interfaceSubscribableClassDefinitionRepresents the class definition (mutable class metadata) of classes whose instances can be the target of a subscription and can be audited.interfaceTableDefinitionRepresents the description of a Content Engine database table.interfaceVersionableClassDefinitionRepresents the parent of theDocumentClassDefinitionclass, which holds the class definition of aDocumentclass and its subclasses.interfaceXMLPropertyMappingScriptRepresents the definition of aDocumentsubclass for defining XML property mapping scripts. -
Uses of RepositoryObject in com.filenet.api.core
Subinterfaces of RepositoryObject in com.filenet.api.core Modifier and Type Interface and Description interfaceAnnotationRepresents an annotation that can be applied to a document, folder, or custom object.interfaceCmAbstractDependentinterfaceCmAbstractPersistableCustomizable base for classes of objects that can provide basic subscribable and replicable independently persistable behaviour.interfaceCmTaskRepresents a single work item to be completed as part of a process that might involve multiple related or independent work items.interfaceCmTaskRelationshipDefines a predecessor-successor relationship between twoCmTaskobjects.interfaceCmThumbnailRepresents a thumbnail image corresponding to aContentElementof aDocument.interfaceComponentRelationshipDefines a hierarchical relationship between two documents as components in a compound document.interfaceContainmentRelationshipModels containment relationships.interfaceContentElementRepresents the superclass for classes used to access document or annotation content data.interfaceContentReferenceRepresents external content data that exists outside of an object store (and therefore outside the control of the Content Engine server), but to which an object store maintains a reference.interfaceContentTransferRepresents content data that is local to an object store and directly managed by the Content Engine server.interfaceCustomObjectRepresents a general interface that can be subclassed.interfaceDocumentRepresents a single version of a document stored in an object store.interfaceDynamicReferentialContainmentRelationshipRepresents a dynamic relationship between twoContainablesubclasses: a container and the current version of aDocument.interfaceFolderRepresents a container that can hold otherContainablesubclasses, but cannot have content data of its own.interfaceLinkRepresents a relationship between two objects.interfaceReferentialContainmentRelationshipRepresents a static relationship between twoContainablesubclasses: a container and a containee.interfaceRelationshipRepresents the base class for binary relationships between independently persistable objects of an object store.interfaceVersionSeriesRepresents the complete set of versions for a versionable object, or document (that is, an object instantiated from a subinterface of theVersionableinterface).interfaceWorkflowDefinitionRepresents a workflow definition, an XML document of class "WorkflowDefinition" that is stored in a Content Engine object store. -
Uses of RepositoryObject in com.filenet.api.events
Subinterfaces of RepositoryObject in com.filenet.api.events Modifier and Type Interface and Description interfaceActionRepresents a server-extensible, user-implemented action in response to an event triggered on a source object, or to an instance of a class definition getting created or updated.interfaceActionConsumerRepresents consumer ofAction-based objects.interfaceAuditConfigurationEventRepresents an event that occurs when the auditing configuration of an object store is changed.interfaceCancelCheckoutEventRepresents an event that occurs when a reservation on a versionable object is canceled.interfaceChangeClassEventRepresents an event that occurs when the class of an object is changed.interfaceChangeStateEventRepresents an event that occurs when the lifecycle state of aDocumentobject changes, or when the state of aCmTaskobject changes.interfaceCheckinEventRepresents an event that occurs when a versionable object is checked in.interfaceCheckoutEventRepresents an event that occurs when a versionable object is checked out.interfaceClassifyCompleteEventRepresents an event that occurs when a document has been auto-classified, that is, assigned a document class automatically during checkin.interfaceClassSubscriptionRepresents a subscription for events generated by all objects of a particular class.interfaceClassWorkflowSubscriptionRepresents a subscription that initiates a workflow in response to events generated by all objects of a particular class.interfaceCmChangePreprocessorActionDefines the action to be taken when a change preprocessor is invoked on a class definition.interfaceCmMarkForDeletionEventRepresents an event that occurs when an object is marked for deletion.interfaceCmMoveContentEventEvent reported when the content of an object is moved.interfaceCmRecoverEventRepresents an event that occurs when an object marked for deletion is restored from a recovery bin.interfaceCmThumbnailGenerationSubscriptionRepresents a subscription used to initiate event-based document thumbnail generation.interfaceCreationEventRepresents an event that occurs when an object instance of a class is created and saved.interfaceCustomEventRepresents a user-defined custom event.interfaceDeletionEventRepresents an event that occurs when an object is deleted from the object store.interfaceDemoteVersionEventRepresents an event that occurs when a versionable object is demoted to a minor version.interfaceDocumentClassificationActionAssociates a server-side document classifier with documents of a defined MIME type.interfaceDocumentLifecycleActionRepresents the actions to be taken when a document's lifecycle state is changed.interfaceDocumentLifecyclePolicyRepresents the lifecycle policy for a document.interfaceDocumentStateRepresents a valid lifecycle state of a document lifecycle policy.interfaceEventRepresents a system or custom event that can be triggered on an Content Engine object or class of objects.interfaceEventActionRepresents the actions taken when a subscribed event fires.interfaceFileEventRepresents an event that occurs when theFolder.filemethod is called to file aContainableobject, for example, aDocument,CustomObject, or when theFolder.createSubFoldermethod is called.interfaceFreezeEventRepresents an event that occurs when thefreezemethod of aVersionableobject is successfully called.interfaceGetContentEventRepresents an event that occurs when the content of a content-carrying object is retrieved.interfaceGetObjectEventRepresents an event that occurs when an object is retrieved from the object store.interfaceInstanceSubscriptionRepresents a subscription for events generated by a single object instance of a particular class.interfaceInstanceWorkflowSubscriptionRepresents a subscription that initiates a workflow in response to events generated by a single object instance.interfaceLockEventRepresents an event that occurs when thelockmethod is called to lock or update an existing lock on aDocument,CustomObject, orFolderobject.interfaceObjectChangeEventRepresents an event that occurs when the state of an object is changed.interfacePromoteVersionEventRepresents an event that occurs when a document is promoted or checked in as a major version.interfaceQueryEventRepresents an event that occurs whenever a database query is performed.interfaceRetrievalEventRepresents an event that occurs when a Content Engine object or its content is retrieved or queried.interfaceSubscribedEventASubscribedEventobject represents a system or custom event that applies to aSubscriptionobject.interfaceSubscriptionRepresents a request to execute an event action when an event is triggered on a target Content Engine object.interfaceTakeFederatedOwnershipEventEvent reported when thetakeFederatedOwnershipmethod is applied to a Document object.interfaceUnfileEventRepresents an event that occurs when a folder has itsunfilemethod called to remove (unfile) aContainableobject, for example, aDocumentorCustomObject, or when a subfolder is deleted.interfaceUnlockEventRepresents an event that occurs when theunlockmethod is called on aDocument,CustomObject, orFolderobject.interfaceUpdateEventRepresents an event that occurs when changes are made to an object's properties.interfaceUpdateSecurityEventRepresents an event that occurs when the security of an object is changed.interfaceWorkflowEventActionRepresents the launching of a workflow when an event defined in a subscription is fired. -
Uses of RepositoryObject in com.filenet.api.query
Subinterfaces of RepositoryObject in com.filenet.api.query Modifier and Type Interface and Description interfaceStoredSearchRepresents the search criteria for a stored search or search template. -
Uses of RepositoryObject in com.filenet.api.replication
Subinterfaces of RepositoryObject in com.filenet.api.replication Modifier and Type Interface and Description interfaceExternalAliasRepresents the mechanism for mapping a class or property in an external repository to a corresponding Content Engine class or property.interfaceExternalClassAliasRepresents the mechanism for mapping a class in an external repository to a corresponding Content Engine class.interfaceExternalIdentityRepresents the identity of a replicated object in an external repository.interfaceExternalPropertyAliasRepresents the mechanism for mapping a property in an external repository to a corresponding Content Engine property.interfaceReplicationJournalEntryRepresents the journal record of an operation on a replicated object for outbound replication from a Content Engine object store to an external repository. -
Uses of RepositoryObject in com.filenet.api.security
Subinterfaces of RepositoryObject in com.filenet.api.security Modifier and Type Interface and Description interfaceActiveMarkingRepresents a marking that is currently applied to a given object.interfaceApplicationSecurityTemplateRepresents a template through which an application can apply permissions (access rights) to aDocument,CustomObject, orFolderobject, and to their subclasses.interfaceCmDynamicRoleThe base class for roles having membership evaluated dynamically.interfaceCmRoleThe base class for roles.interfaceCmRoleMemberBase for classes defining the membership of a role.interfaceCmRolePrincipalMemberDefines a security principal as a member of a static role.interfaceCmRoleRealmMemberDefines all users of a specified realm as members of a static role.interfaceCmRoleRoleMemberSpecifies a nested role, whose members are to be treated as members of this static role.interfaceCmStaticRoleThe base class for roles having a statically defined membership.interfaceSecurityPolicyRepresents an independently persistable, subclassable container for a list of security templates.interfaceSecurityTemplateRepresents the base class for security template classes.interfaceVersioningSecurityTemplateRepresents a template for automatically applying permissions (access rights) to aDocumentobject during versioning state changes. -
Uses of RepositoryObject in com.filenet.api.sweep
Subinterfaces of RepositoryObject in com.filenet.api.sweep Modifier and Type Interface and Description interfaceCmAbstractSearchResultThe abstract, base class from which you create a subclass to define the class of objects that are returned in a background search result.interfaceCmBackgroundSearchThe base class from which you can create a subclass to define the search expression and parameters for a background search.interfaceCmBulkMoveContentJobRepresents a background task that moves content from one storage area to another.interfaceCmContentBackoutQueueEntryRepresents the information needed for aCmContentBackoutQueueSweepto back out content abandoned during upload to an advanced storage area.interfaceCmContentBackoutQueueSweepRepresents a queue sweep that processes content backout queue entries in the advanced storage areas of an object store.interfaceCmContentConsistencyCheckJobinterfaceCmContentDeletionQueueEntryRepresents the information needed for aCmContentDeletionQueueSweepto delete content from an advanced storage area.interfaceCmContentDeletionQueueSweepRepresents a queue sweep that processes content deletion queue entries in the advanced storage areas of an object store.interfaceCmContentMigrationPolicyRepresents a background task that moves content from one storage area to another.interfaceCmContentReplicationQueueEntryRepresents the information needed for aCmContentReplicationQueueSweepto replicate content within an advanced storage area.interfaceCmContentReplicationQueueSweepRepresents a queue sweep that processes content replication queue entries within an advanced storage area of an object store.interfaceCmCustomQueueSweepRepresents a background task that operates continuously, periodically sweeping over a queue table specified as a target class.interfaceCmCustomSweepJobRepresents a background task that performs a one-time sweep over a specified target class and retrieves instances that meet the criteria set on the job's filter expression.interfaceCmCustomSweepPolicyRepresents a background task that performs an indefinite number of sweeps over a specified target class and retrieves instances that meet the criteria set on the policy's filter expression.interfaceCmDisposalPolicyDefines criteria for objects of a specified class to be disposed by a policy controlled sweep.interfaceCmElasticSearchIndexingSweepinterfaceCmElasticSearchIndexRequestinterfaceCmJobSweepResultDefines a result record generated by a sweep job.interfaceCmPolicyControlledSweepRepresents a background service that repeatedly visits all instances of a specified class residing in a single database table.interfaceCmPolicySweepResultDefines a result record generated by a sweep policy.interfaceCmQueueSweepAbstract base class for sweep instances that are optimized for ongoing processing of queue tables.interfaceCmRetentionUpdateJobRepresents a background task that updates the retention date on objects that support it.interfaceCmRetentionUpdatePolicyDefines criteria for updating the retention period for objects of a specified class by a policy controlled sweep.interfaceCmSweepAn abstract base class for an object that represents a background service that visits all instances of a specified class.interfaceCmSweepActionDefines the action to be taken when a custom sweep (CmCustomSweepJob,CmCustomSweepPolicy, orCmCustomQueueSweep) is invoked.interfaceCmSweepJobAbstract base class for a sweep that visits each instance of the specified class exactly once.interfaceCmSweepPolicyAbstract base class for objects that specify rules for a policy controlled sweep, represented by aCmPolicyControlledSweepobject.interfaceCmSweepPolicyRelationshipConcrete subclass that defines an association between aCmPolicyControlledSweepand aCmSweepPolicy, as set in the Sweep property and the SweepSubscriber property, respectively.interfaceCmSweepRelationshipAbstract base class for objects that define an association between a policy controlled sweep and a sweep policy.interfaceCmSweepResultRepresents a result record for an object selected by a sweep.interfaceCmThumbnailGenerationJobRepresents a background task that initiates sweep-based document thumbnail generation.interfaceCmThumbnailRequestRepresents a request to generate a thumbnail image for aContentElementof aDocument.interfaceCmThumbnailRequestSweepDefines the format, size, and color parameters that are used by the thumbnail generation service to render document thumbnails. -
Uses of RepositoryObject in com.filenet.api.util
Subinterfaces of RepositoryObject in com.filenet.api.util Modifier and Type Interface and Description interfaceCmAbstractSequentialCustomizable base for classes of objects that have a system-generated, unique, monotonically increasing sequence number property.interfaceCmRecoveryBinA container forCmRecoveryItemobjects.interfaceCmRecoveryItemA representative for one or more objects that have been marked for deletion.
-