Content Engine Java API: Subscribable

All Known Subinterfaces:

Action, ActionConsumer, Annotation, ChoiceList, ClassDefinition, ClassSubscription, ClassWorkflowSubscription, CmAbstractPersistable, CmAuditDispositionPolicy, CmAuditProcessingBookmark, CmBulkMoveContentJob, CmChangePreprocessorAction, CmContentMigrationPolicy, CmCustomQueueSweep, CmCustomSweepJob, CmCustomSweepPolicy, CmDisposalPolicy, CmHold, CmHoldRelationship, CmPolicyControlledSweep, CmQueueEntryClassDefinition, CmQueueSweep, CmRecoveryBin, CmRecoveryItem, CmRetentionUpdateJob, CmRetentionUpdatePolicy, CmSweep, CmSweepAction, CmSweepJob, CmSweepPolicy, CmSweepPolicyRelationship, CmSweepRelationship, CmTask, CmTaskRelationship, CmTextSearchIndexArea, CmThumbnail, CmThumbnailGenerationJob, CmThumbnailGenerationSubscription, CmThumbnailRequestSweep, 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, StoredSearch, 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:
- By calling the get_SubscriptionTarget method on a Subscription-based object.
- By returning a Subscribable object from a SubscribableSet collection.
Metadata

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

- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  void raiseEvent(CustomEvent customEvent)
  Raises a custom event for this Subscribable object.

Methods
Modifier and Type	Method and Description
`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:
    - An appropriate CustomEvent object must exist.
    - A subscription subscribes to the Subscribable object; that is, the subscription's SubscriptionTarget property has been set to this Subscribable object.
    - A subscription subscribes to the custom event to be raised; that is, the subscription's SubscribedEvents property has been set to a SubscribedEventList collection that includes the custom event.
    Parameters:
    customEvent - The CustomEvent object to be raised.

raiseEvent