com.filenet.api.core
Interface Subscribable

All Known Subinterfaces:
Action, ActionConsumer, Annotation, ChoiceList, ClassDefinition, ClassSubscription, ClassWorkflowSubscription, CodeModule, ComponentRelationship, ContainmentRelationship, CustomObject, DatabaseStorageArea, Document, DocumentClassDefinition, DocumentClassificationAction, DocumentLifecycleAction, DocumentLifecyclePolicy, DynamicReferentialContainmentRelationship, EventAction, EventClassDefinition, FileStorageArea, FixedStorageArea, Folder, IndexArea, InstanceSubscription, InstanceWorkflowSubscription, Link, PropertyTemplate, PropertyTemplateBinary, PropertyTemplateBoolean, PropertyTemplateDateTime, PropertyTemplateFloat64, PropertyTemplateId, PropertyTemplateInteger32, PropertyTemplateObject, PropertyTemplateString, PublishRequest, PublishStyleTemplate, PublishTemplate, ReferentialContainmentRelationship, Relationship, ReplicableClassDefinition, SecurityPolicy, StorageArea, StoragePolicy, SubscribableClassDefinition, Subscription, VerityIndexArea, VersionableClassDefinition, VersionSeries, WorkflowDefinition, WorkflowEventAction, XMLPropertyMappingScript

public interface Subscribable

Serves as a target of an event subscription, represented by a Subscription-based object. Subscribable is a base interface of several derived interfaces that can be used as a subscription target. To set a Subscribable object as the target of a subscription, use the SubscriptionTarget property of the Subscription-based object.

You can instantiate a Subscribable object in the following ways:

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject


Method Summary
 void raiseEvent(CustomEvent customEvent)
          Raises a custom event for this Subscribable object.
 

Method Detail

raiseEvent

void raiseEvent(CustomEvent customEvent)
Raises a custom event for this Subscribable object. For example, you can define a custom event class in the Content Engine for an operation such as publishing a document, then specify the custom event in a call to the raiseEvent method on a Document object after you call the publish method on that document.

Before you can use this method, the following conditions must be met:

Parameters:
customEvent - The CustomEvent object to be raised.


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