com.filenet.api.events
Interface InstanceWorkflowSubscription

All Superinterfaces:
ActionConsumer, EngineObject, IndependentlyPersistableObject, IndependentObject, InstanceSubscription, Replicable, RepositoryObject, java.io.Serializable, Subscribable, Subscription

public interface InstanceWorkflowSubscription
extends RepositoryObject, InstanceSubscription

Represents a subscription that initiates a workflow in response to events generated by a single object instance. A InstanceWorkflowSubscription object provides object properties to link a workflow (WorkflowDefinition), a target object, and one or more events (SubscribedEvent) that can be triggered on the target object. These objects must exist before you can create a InstanceWorkflowSubscription object and persist it.

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

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

Metadata

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


Method Summary
 java.lang.Boolean get_EnableManualLaunch()
          Returns the value of the EnableManualLaunch property.
 java.lang.Integer get_IsolatedRegionNumber()
          Returns the value of the IsolatedRegionNumber property.
 StringList get_PropertyMap()
          Returns the value of the PropertyMap property.
 java.lang.String get_Subject()
          Returns the value of the Subject property.
 java.lang.String get_VWVersion()
          Returns the value of the VWVersion property.
 WorkflowDefinition get_WorkflowDefinition()
          Returns the value of the WorkflowDefinition property.
 void set_EnableManualLaunch(java.lang.Boolean value)
          Sets the value of the EnableManualLaunch property.
 void set_IsolatedRegionNumber(java.lang.Integer value)
          Sets the value of the IsolatedRegionNumber property.
 void set_PropertyMap(StringList value)
          Sets the value of the PropertyMap property.
 void set_Subject(java.lang.String value)
          Sets the value of the Subject property.
 void set_VWVersion(java.lang.String value)
          Sets the value of the VWVersion property.
 void set_WorkflowDefinition(WorkflowDefinition value)
          Sets the value of the WorkflowDefinition 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.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_WorkflowDefinition

WorkflowDefinition get_WorkflowDefinition()
Returns the value of the WorkflowDefinition property. For more information, see WorkflowDefinition Property.


set_WorkflowDefinition

void set_WorkflowDefinition(WorkflowDefinition value)
Sets the value of the WorkflowDefinition property. For more information, see WorkflowDefinition Property.


get_IsolatedRegionNumber

java.lang.Integer get_IsolatedRegionNumber()
Returns the value of the IsolatedRegionNumber property. For more information, see IsolatedRegionNumber Property.


set_IsolatedRegionNumber

void set_IsolatedRegionNumber(java.lang.Integer value)
Sets the value of the IsolatedRegionNumber property. For more information, see IsolatedRegionNumber Property.


get_Subject

java.lang.String get_Subject()
Returns the value of the Subject property. For more information, see Subject Property.


set_Subject

void set_Subject(java.lang.String value)
Sets the value of the Subject property. For more information, see Subject Property.


get_VWVersion

java.lang.String get_VWVersion()
Returns the value of the VWVersion property. For more information, see VWVersion Property.


set_VWVersion

void set_VWVersion(java.lang.String value)
Sets the value of the VWVersion property. For more information, see VWVersion Property.


get_EnableManualLaunch

java.lang.Boolean get_EnableManualLaunch()
Returns the value of the EnableManualLaunch property. For more information, see EnableManualLaunch Property.


set_EnableManualLaunch

void set_EnableManualLaunch(java.lang.Boolean value)
Sets the value of the EnableManualLaunch property. For more information, see EnableManualLaunch Property.


get_PropertyMap

StringList get_PropertyMap()
Returns the value of the PropertyMap property. For more information, see PropertyMap Property.


set_PropertyMap

void set_PropertyMap(StringList value)
Sets the value of the PropertyMap property. For more information, see PropertyMap Property.



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