• Packages that use Subscribable 
    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.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 Subscribable in com.filenet.api.admin

      Subinterfaces of Subscribable in com.filenet.api.admin 
      Modifier and Type Interface and Description
      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  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  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  CmQueueEntryClassDefinition
      Mutable metadata class defining a subclass of CmAbstractQueueEntry.
      interface  CmTextSearchIndexArea
      Represents the configuration of an IBM® Content Search Services index area.
      interface  CodeModule
      Represents a Java action handler to be stored on the Content Engine.
      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  EventClassDefinition
      Represents the class definition (mutable class metadata) of event classes whose instances can be subscribed to or audited.
      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  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  ReplicableClassDefinition
      Represents the class definition (mutable class metadata) of classes of which an object instance can be replicated.
      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  VerityIndexArea
      Deprecated. 
      As of release 5.2.0.

      Metadata

      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 Subscribable in com.filenet.api.core

      Subinterfaces of Subscribable 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  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 Subscribable in com.filenet.api.events

      Subinterfaces of Subscribable 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  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  CmThumbnailGenerationSubscription
      Represents a subscription used to initiate event-based document thumbnail generation.
      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  EventAction
      Represents the actions taken when a subscribed event fires.
      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  Subscription
      Represents a request to execute an event action when an event is triggered on a target Content Engine object.
      interface  WorkflowEventAction
      Represents the launching of a workflow when an event defined in a subscription is fired.
      Methods in com.filenet.api.events that return Subscribable 
      Modifier and Type Method and Description
      Subscribable Subscription.get_SubscriptionTarget()
      Returns the value of the SubscriptionTarget property.
      Methods in com.filenet.api.events with parameters of type Subscribable 
      Modifier and Type Method and Description
      void Subscription.set_SubscriptionTarget(Subscribable value)
      Sets the value of the SubscriptionTarget property.
    • Uses of Subscribable in com.filenet.api.publishing

      Subinterfaces of Subscribable 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 Subscribable in com.filenet.api.query

      Subinterfaces of Subscribable 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 Subscribable in com.filenet.api.security

      Subinterfaces of Subscribable in com.filenet.api.security 
      Modifier and Type Interface and Description
      interface  SecurityPolicy
      Represents an independently persistable, subclassable container for a list of security templates.
    • Uses of Subscribable in com.filenet.api.sweep

      Subinterfaces of Subscribable 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  CmPolicyControlledSweep
      Represents a background service that repeatedly visits all instances of a specified class residing in a single database table.
      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  CmThumbnailGenerationJob
      Represents a background task that initiates sweep-based document thumbnail generation.
      interface  CmThumbnailRequestSweep
      Defines the format, size, and color parameters that are used by the thumbnail generation service to render document thumbnails.
    • Uses of Subscribable in com.filenet.api.util

      Subinterfaces of Subscribable in com.filenet.api.util 
      Modifier and Type Interface and Description
      interface  CmRecoveryBin
      A container for CmRecoveryItem objects.
      interface  CmRecoveryItem
      A representative for one or more objects that have been marked for deletion.
      Methods in com.filenet.api.util that return Subscribable 
      Modifier and Type Method and Description
      Subscribable CmRecoveryItem.get_OriginalObject()
      Returns the value of the OriginalObject property.
      Methods in com.filenet.api.util with parameters of type Subscribable 
      Modifier and Type Method and Description
      void CmRecoveryItem.set_OriginalObject(Subscribable value)
      Sets the value of the OriginalObject property.

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