Content Engine Java API: Uses of Interface com.filenet.api.core.RepositoryObject

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 as `EntireNetwork`, `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.publishing	Provides interfaces related to publishing.
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
`interface`	`AddOnInstallationRecord` Represents a record that contains information pertaining to the installation of an add-on.
`interface`	`AsyncUpgradeQueueItem` For internal use only.
`interface`	`AuditDefinition` Represents a definition that specifies audit-event parameters.
`interface`	`Choice` Represents 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.
`interface`	`ChoiceList` Represents a choice list in an object store.
`interface`	`ClassDefinition` Represents the class definition (mutable class metadata) of non-versionable, non-subscribable classes.
`interface`	`CmAbstractQueueEntry` Customizable base for classes of objects that can be processed by a queue sweep.
`interface`	`CmAuditDispositionPolicy` Defines the criteria in which audit records are identified for disposition (deletion).
`interface`	`CmAuditProcessingBookmark` Represents 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.
`interface`	`CmChangePreprocessorDefinition` Associates a `CmChangePreprocessorAction` object with a class definition.
`interface`	`CmHold` Represents a hold on an object of type `CmHoldable`, preventing that object from being deleted for an indefinite period of time, until the hold is explicitly removed.
`interface`	`CmHoldRelationship` Defines a hold-held relationship between `CmHold` (hold object) and `CmHoldable` object (the held object).
`interface`	`CmIndexJobResyncItem` Represents an index job that resynchronizes a full-text index with the data in an object store database.
`interface`	`CmIndexPartitionConstraint` Represents an index partition constraint associated with an IBM® Content Search Services index.
`interface`	`CmIndexPartitionConstraintDate` Represents the date range of a date partition constraint for an IBM® Content Search Services index.
`interface`	`CmIndexPartitionConstraintString` Represents the name and value of a string partition constraint for an IBM® Content Search Services index.
`interface`	`CmIndexRequest` Represents the base class for index requests.
`interface`	`CmQueueEntryClassDefinition` Mutable metadata class defining a subclass of `CmAbstractQueueEntry`.
`interface`	`CmTextSearchIndex` Represents 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.
`interface`	`CmTextSearchIndexArea` Represents the configuration of an IBM® Content Search Services index area.
`interface`	`CmTextSearchIndexRequest` Represents an index request generated for a text search-enabled object for IBM® Content Search Services.
`interface`	`CmVerityIndexRequest` Deprecated. As of release 5.2.0. Metadata Auditable: false AllowsInstances: false AllowsSubClasses: false ClassDefinitionName: ClassDefinition IsDependent: false IsHidden: false Searchable: true StorageType: ObjectStore SuperclassName: CmIndexRequest
`interface`	`CodeModule` Represents a Java action handler to be stored on the Content Engine.
`interface`	`ColumnDefinition` Represents the description of a column in a Content Engine database table.
`interface`	`DatabaseStorageArea` Represents a storage area for content elements stored in the database.
`interface`	`DocumentClassDefinition` Represents the class definition (mutable class metadata) of the `Document` class and its subclasses.
`interface`	`DocumentClassificationQueueItem` Represents a pending (queued) document auto-classification request.
`interface`	`EventClassDefinition` Represents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited.
`interface`	`EventQueueItem` Represents a pending (queued) execution of an asynchronous event action, or an asynchronous event queue item that remains unprocessed because its retry count is zero.
`interface`	`FileStorageArea` Represents a storage area for content elements stored in the file system.
`interface`	`FixedStorageArea` Represents a storage area for content elements stored in a fixed content device.
`interface`	`IndexArea` Represents the disk storage location and data necessary to perform full-text indexing for content-based retrieval.
`interface`	`IndexJob` Initiates and tracks the status of a full-text indexing operation.
`interface`	`IndexJobClassItem` Identifies the class to be full-text indexed.
`interface`	`IndexJobCollectionItem` Identifies an IBM® Content Search Services index to be full-text indexed.
`interface`	`IndexJobItem` Indicates a particular item that is being full text indexed.
`interface`	`IndexJobSingleItem` Identifies an object to be full-text indexed.
`interface`	`LocalizedString` Provides a means of support for locale-specific display names and descriptive text used by a class definition or property template.
`interface`	`PropertyDefinition` Represents the base class for all property definition classes.
`interface`	`PropertyDefinitionBinary` Represents the definition of a property that holds a binary value.
`interface`	`PropertyDefinitionBoolean` Represents the definition of a property that holds a Boolean value.
`interface`	`PropertyDefinitionDateTime` Represents the definition of a property that holds a DateTime value.
`interface`	`PropertyDefinitionFloat64` Represents the definition of a property that holds a Double (Float64) value.
`interface`	`PropertyDefinitionId` Represents the definition of a property that holds a GUID string value.
`interface`	`PropertyDefinitionInteger32` Represents the definition of a property that holds an integer value.
`interface`	`PropertyDefinitionObject` Represents the definition of a property that holds a Content Engine object value.
`interface`	`PropertyDefinitionString` Represents the definition of a property that holds a string value.
`interface`	`PropertyTemplate` Represents the base class for all property template classes.
`interface`	`PropertyTemplateBinary` Represents a property template for creating `PropertyDefinitionBinary` objects, which you can add to class definitions to create user-defined properties for holding binary values.
`interface`	`PropertyTemplateBoolean` Represents a property template for creating `PropertyDefinitionBoolean` objects, which you can add to class definitions to create user-defined properties for holding Boolean values.
`interface`	`PropertyTemplateDateTime` Represents a property template for creating `PropertyDefinitionDateTime` objects, which you can add to class definitions to create user-defined properties for holding DateTime values.
`interface`	`PropertyTemplateFloat64` Represents a property template for creating `PropertyDefinitionFloat64` objects, which you can add to class definitions to create user-defined properties for holding Double (Float64) values.
`interface`	`PropertyTemplateId` Represents a property template for creating `PropertyDefinitionId` objects, which you can add to class definitions to create user-defined properties for holding GUID string values.
`interface`	`PropertyTemplateInteger32` Represents a property template for creating `PropertyDefinitionInteger32` objects, which you can add to class definitions to create user-defined properties for holding integer values.
`interface`	`PropertyTemplateObject` Represents a property template for creating `PropertyDefinitionObject` objects, which you can add to class definitions to create user-defined properties for holding Content Engine object values.
`interface`	`PropertyTemplateString` Represents a property template for creating `PropertyDefinitionString` objects, which you can add to class definitions to create user-defined properties for holding string values.
`interface`	`QueueItem` This class is the base class for all queue-related classes.
`interface`	`ReplicableClassDefinition` Represents the class definition (mutable class metadata) of classes of which an object instance can be replicated.
`interface`	`SecurityPropagationQueueItem` Represents a pending (queued) execution of an asynchronous security propagation action on a target object.
`interface`	`StorageArea` Represents the physical storage location where content will be stored.
`interface`	`StoragePolicy` Represents a subset of available storage areas that are deemed equivalent based on common, user-specified criteria.
`interface`	`SubscribableClassDefinition` Represents the class definition (mutable class metadata) of classes whose instances can be the target of a subscription and can be audited.
`interface`	`TableDefinition` Represents the description of a Content Engine database table.
`interface`	`VerityCollection` Deprecated. As of release 5.2.0. Metadata Auditable: false AllowsInstances: false AllowsSubClasses: false ClassDefinitionName: None IsDependent: true IsHidden: false Searchable: false StorageType: ObjectStore SuperclassName: GenericObject
`interface`	`VerityIndexArea` Deprecated. As of release 5.2.0. Metadata Auditable: true AllowsInstances: true AllowsSubClasses: true ClassDefinitionName: SubscribableClassDefinition IsDependent: false IsHidden: false Name: DisplayName Searchable: true StorageType: ObjectStore SuperclassName: IndexArea
`interface`	`VersionableClassDefinition` Represents the parent of the `DocumentClassDefinition` class, which holds the class definition of a `Document` class and its subclasses.
`interface`	`XMLPropertyMappingScript` Represents the definition of a `Document` subclass 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
`interface`	`Annotation` Represents an annotation that can be applied to a document, folder, or custom object.
`interface`	`CmAbstractPersistable` Customizable base for classes of objects that can provide basic subscribable and replicable independently persistable behaviour.
`interface`	`CmTask` Represents a single work item to be completed as part of a process that might involve multiple related or independent work items.
`interface`	`CmTaskRelationship` Defines a predecessor-successor relationship between two `CmTask` objects.
`interface`	`CmThumbnail` Represents a thumbnail image corresponding to a `ContentElement` of a `Document`.
`interface`	`ComponentRelationship` Defines a hierarchical relationship between two documents as components in a compound document.
`interface`	`ContainmentRelationship` Models containment relationships.
`interface`	`ContentElement` Represents the superclass for classes used to access document or annotation content data.
`interface`	`ContentReference` Represents 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.
`interface`	`ContentTransfer` Represents content data that is local to an object store and directly managed by the Content Engine server.
`interface`	`CustomObject` Represents a general interface that can be subclassed.
`interface`	`Document` Represents a single version of a document stored in an object store.
`interface`	`DynamicReferentialContainmentRelationship` Represents a dynamic relationship between two `Containable` subclasses: a container and the current version of a `Document`.
`interface`	`Folder` Represents a container that can hold other `Containable` subclasses, but cannot have content data of its own.
`interface`	`Link` Represents a relationship between two objects.
`interface`	`ReferentialContainmentRelationship` Represents a static relationship between two `Containable` subclasses: a container and a containee.
`interface`	`Relationship` Represents the base class for binary relationships between independently persistable objects of an object store.
`interface`	`VersionSeries` Represents the complete set of versions for a versionable object, or document (that is, an object instantiated from a subinterface of the `Versionable` interface).
`interface`	`WorkflowDefinition` Represents 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
`interface`	`Action` Represents 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.
`interface`	`ActionConsumer` Represents consumer of `Action-based objects`.
`interface`	`AuditConfigurationEvent` Represents an event that occurs when the auditing configuration of an object store is changed.
`interface`	`CancelCheckoutEvent` Represents an event that occurs when a reservation on a versionable object is canceled.
`interface`	`ChangeClassEvent` Represents an event that occurs when the class of an object is changed.
`interface`	`ChangeStateEvent` Represents an event that occurs when the lifecycle state of a `Document` object changes, or when the state of a `CmTask` object changes.
`interface`	`CheckinEvent` Represents an event that occurs when a versionable object is checked in.
`interface`	`CheckoutEvent` Represents an event that occurs when a versionable object is checked out.
`interface`	`ClassifyCompleteEvent` Represents an event that occurs when a document has been auto-classified, that is, assigned a document class automatically during checkin.
`interface`	`ClassSubscription` Represents a subscription for events generated by all objects of a particular class.
`interface`	`ClassWorkflowSubscription` Represents a subscription that initiates a workflow in response to events generated by all objects of a particular class.
`interface`	`CmChangePreprocessorAction` Defines the action to be taken when a change preprocessor is invoked on a class definition.
`interface`	`CmMarkForDeletionEvent` Represents an event that occurs when an object is marked for deletion.
`interface`	`CmMoveContentEvent` Event reported when the content of an object is moved.
`interface`	`CmRecoverEvent` Represents an event that occurs when an object marked for deletion is restored from a recovery bin.
`interface`	`CmThumbnailGenerationSubscription` Represents a subscription used to initiate event-based document thumbnail generation.
`interface`	`CreationEvent` Represents an event that occurs when an object instance of a class is created and saved.
`interface`	`CustomEvent` Represents a user-defined custom event.
`interface`	`DeletionEvent` Represents an event that occurs when an object is deleted from the object store.
`interface`	`DemoteVersionEvent` Represents an event that occurs when a versionable object is demoted to a minor version.
`interface`	`DocumentClassificationAction` Associates a server-side document classifier with documents of a defined MIME type.
`interface`	`DocumentLifecycleAction` Represents the actions to be taken when a document's lifecycle state is changed.
`interface`	`DocumentLifecyclePolicy` Represents the lifecycle policy for a document.
`interface`	`DocumentState` Represents a valid lifecycle state of a document lifecycle policy.
`interface`	`Event` Represents a system or custom event that can be triggered on an Content Engine object or class of objects.
`interface`	`EventAction` Represents the actions taken when a subscribed event fires.
`interface`	`FileEvent` Represents an event that occurs when the `Folder.file` method is called to file a `Containable` object, for example, a `Document`, `CustomObject`, or when the `Folder.createSubFolder` method is called.
`interface`	`FreezeEvent` Represents an event that occurs when the `freeze` method of a `Versionable` object is successfully called.
`interface`	`GetContentEvent` Represents an event that occurs when the content of a content-carrying object is retrieved.
`interface`	`GetObjectEvent` Represents an event that occurs when an object is retrieved from the object store.
`interface`	`InstanceSubscription` Represents a subscription for events generated by a single object instance of a particular class.
`interface`	`InstanceWorkflowSubscription` Represents a subscription that initiates a workflow in response to events generated by a single object instance.
`interface`	`LockEvent` Represents an event that occurs when the `lock` method is called to lock or update an existing lock on a `Document`, `CustomObject`, or `Folder` object.
`interface`	`ObjectChangeEvent` Represents an event that occurs when the state of an object is changed.
`interface`	`PromoteVersionEvent` Represents an event that occurs when a document is promoted or checked in as a major version.
`interface`	`PublishCompleteEvent` Represents an event that occurs when a document-publishing request has completed.
`interface`	`PublishRequestEvent` Represents an event that occurs when a request has been made to publish or republish a document.
`interface`	`QueryEvent` Represents an event that occurs whenever a database query is performed.
`interface`	`RetrievalEvent` Represents an event that occurs when a Content Engine object or its content is retrieved or queried.
`interface`	`SubscribedEvent` A `SubscribedEvent` object represents a system or custom event that applies to a `Subscription` object.
`interface`	`Subscription` Represents a request to execute an event action when an event is triggered on a target Content Engine object.
`interface`	`TakeFederatedOwnershipEvent` Event reported when the `takeFederatedOwnership` method is applied to a Document object.
`interface`	`UnfileEvent` Represents an event that occurs when a folder has its `unfile` method called to remove (unfile) a `Containable` object, for example, a `Document` or `CustomObject`, or when a subfolder is deleted.
`interface`	`UnlockEvent` Represents an event that occurs when the `unlock` method is called on a `Document`, `CustomObject`, or `Folder` object.
`interface`	`UpdateEvent` Represents an event that occurs when changes are made to an object's properties.
`interface`	`UpdateSecurityEvent` Represents an event that occurs when the security of an object is changed.
`interface`	`WorkflowEventAction` Represents the launching of a workflow when an event defined in a subscription is fired.

Uses of RepositoryObject in com.filenet.api.publishing

Subinterfaces of RepositoryObject in com.filenet.api.publishing
Modifier and Type	Interface and Description
`interface`	`PublishRequest` In IBM Content Foundation, the IBM FileNet Rendition Engine is not supported.
`interface`	`PublishStyleTemplate` In IBM Content Foundation, the IBM FileNet Rendition Engine is not supported.
`interface`	`PublishTemplate` In IBM Content Foundation, the IBM FileNet Rendition Engine is not supported.

Uses of RepositoryObject in com.filenet.api.query

Subinterfaces of RepositoryObject in com.filenet.api.query
Modifier and Type	Interface and Description
`interface`	`StoredSearch` Represents 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
`interface`	`ExternalAlias` Represents the mechanism for mapping a class or property in an external repository to a corresponding Content Engine class or property.
`interface`	`ExternalClassAlias` Represents the mechanism for mapping a class in an external repository to a corresponding Content Engine class.
`interface`	`ExternalIdentity` Represents the identity of a replicated object in an external repository.
`interface`	`ExternalPropertyAlias` Represents the mechanism for mapping a property in an external repository to a corresponding Content Engine property.
`interface`	`ReplicationJournalEntry` Represents 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
`interface`	`ActiveMarking` Represents a marking that is currently applied to a given object.
`interface`	`ApplicationSecurityTemplate` Represents a template through which an application can apply permissions (access rights) to a `Document`, `CustomObject`, or `Folder` object, and to their subclasses.
`interface`	`SecurityPolicy` Represents an independently persistable, subclassable container for a list of security templates.
`interface`	`SecurityTemplate` Represents the base class for security template classes.
`interface`	`VersioningSecurityTemplate` Represents a template for automatically applying permissions (access rights) to a `Document` object 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
`interface`	`CmBulkMoveContentJob` Represents a background task that moves content from one storage area to another.
`interface`	`CmContentMigrationPolicy` Represents a background task that moves content from one storage area to another.
`interface`	`CmCustomQueueSweep` This class is not supported.
`interface`	`CmCustomSweepJob` This class is not currently supported.
`interface`	`CmCustomSweepPolicy` This class is not currently supported.
`interface`	`CmDisposalPolicy` Defines criteria for objects of a specified class to be disposed by a policy controlled sweep.
`interface`	`CmJobSweepResult` Defines a result record generated by a sweep job.
`interface`	`CmPolicyControlledSweep` Represents a background service that repeatedly visits all instances of a specified class residing in a single database table.
`interface`	`CmPolicySweepResult` Defines a result record generated by a sweep policy.
`interface`	`CmQueueSweep` Abstract base class for sweep instances that are optimized for ongoing processing of queue tables.
`interface`	`CmRetentionUpdateJob` Represents a background task that updates the retention date on objects that support it.
`interface`	`CmRetentionUpdatePolicy` Defines criteria for updating the retention period for objects of a specified class by a policy controlled sweep.
`interface`	`CmSweep` An abstract base class for an object that represents a background service that visits all instances of a specified class.
`interface`	`CmSweepAction` This class is not supported.
`interface`	`CmSweepJob` Abstract base class for a sweep that visits each instance of the specified class exactly once.
`interface`	`CmSweepPolicy` Abstract base class for objects that specify rules for a policy controlled sweep, represented by a `CmPolicyControlledSweep` object.
`interface`	`CmSweepPolicyRelationship` Concrete subclass that defines an association between a `CmPolicyControlledSweep` and a `CmSweepPolicy`, as set in the Sweep property and the SweepSubscriber property, respectively.
`interface`	`CmSweepRelationship` Abstract base class for objects that define an association between a policy controlled sweep and a sweep policy.
`interface`	`CmSweepResult` Represents a result record for an object selected by a sweep.
`interface`	`CmThumbnailGenerationJob` Represents a background task that initiates sweep-based document thumbnail generation.
`interface`	`CmThumbnailRequest` Represents a request to generate a thumbnail image for a `ContentElement` of a `Document`.
`interface`	`CmThumbnailRequestSweep` Defines 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
`interface`	`CmAbstractSequential` Customizable base for classes of objects that have a system-generated, unique, monotonically increasing sequence number property.
`interface`	`CmRecoveryBin` A container for `CmRecoveryItem` objects.
`interface`	`CmRecoveryItem` A representative for one or more objects that have been marked for deletion.

Metadata

Metadata

Metadata