com.filenet.api.events

Interface ClassSubscription

All Superinterfaces:

ActionConsumer, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable, Subscription

All Known Subinterfaces:

ClassWorkflowSubscription, CmThumbnailGenerationSubscription

public interface ClassSubscription
extends RepositoryObject, Subscription

Represents a subscription for events generated by all objects of a particular class. The target for these subscriptions must be a class definition.

To create a ClassSubscription object, call the createInstance method on the Factory.ClassSubscription class.

You can instantiate a persisted ClassSubscription object in the following ways:

• By calling the getInstance or fetchInstance method on the Factory.ClassSubscription class.
• By instantiating a SubscriptionSet collection, then returning a ClassSubscription object from the collection.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Subscription

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	get_IncludeSubclassesRequested() Returns the value of the IncludeSubclassesRequested property.
void	set_IncludeSubclassesRequested(java.lang.Boolean value) Sets the value of the IncludeSubclassesRequested property.

Methods inherited from interface com.filenet.api.events.Subscription

changeClass, get_EventAction, get_FilteredPropertyId, get_FilterExpression, get_IsEnabled, get_IsSynchronous, get_SubscribedEvents, get_SubscriptionTarget, get_UserString, set_EventAction, set_FilteredPropertyId, set_FilterExpression, set_IsEnabled, set_IsSynchronous, set_SubscribedEvents, set_SubscriptionTarget, set_UserString

Methods inherited from interface com.filenet.api.events.ActionConsumer

get_ActiveMarkings, get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Name, get_Owner, get_Permissions, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Owner, set_Permissions

Methods inherited from interface com.filenet.api.core.RepositoryObject

getObjectStore

Methods inherited from interface com.filenet.api.replication.Replicable

get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup

Methods inherited from interface com.filenet.api.core.Subscribable

raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_IncludeSubclassesRequested

java.lang.Boolean get_IncludeSubclassesRequested()

Returns the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.

set_IncludeSubclassesRequested

void set_IncludeSubclassesRequested(java.lang.Boolean value)

Sets the value of the IncludeSubclassesRequested property. For more information, see IncludeSubclassesRequested Property.