com.filenet.api.events
Interface EventAction

All Superinterfaces:
Action, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
All Known Subinterfaces:
WorkflowEventAction

public interface EventAction
extends RepositoryObject, Action

Represents the actions taken when a subscribed event fires. You associate an event action with a Subscription-based object by setting the object's EventAction property.

To create an EventAction object and persist it to a Content Engine object store, call the createInstance method on the Factory.EventAction class.

You can instantiate an EventAction object in the following ways:

Metadata

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


Method Summary
 void changeClass(java.lang.String className)
          Changes the class of a Content Engine object.
 java.lang.Boolean get_IsEnabled()
          Returns the value of the IsEnabled property.
 SubscriptionSet get_Subscriptions()
          Returns the value of the Subscriptions property.
 void set_IsEnabled(java.lang.Boolean value)
          Sets the value of the IsEnabled property.
 
Methods inherited from interface com.filenet.api.events.Action
get_ActiveMarkings, get_AuditedEvents, get_CodeModule, get_Creator, get_DateCreated, get_DateLastModified, get_DescriptiveText, get_DisplayName, get_Id, get_LastModifier, get_Name, get_Owner, get_Permissions, get_ProgId, get_ScriptText, set_CodeModule, set_Creator, set_DateCreated, set_DateLastModified, set_DescriptiveText, set_DisplayName, set_LastModifier, set_Owner, set_Permissions, set_ProgId, set_ScriptText
 
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_IsEnabled

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


set_IsEnabled

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


get_Subscriptions

SubscriptionSet get_Subscriptions()
Returns the value of the Subscriptions property. For more information, see Subscriptions Property.


changeClass

void changeClass(java.lang.String className)
Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The changeClass method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:

When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:

Parameters:
className - A String specifying the symbolic name, ClassNames constant, ID, or GUIDConstants constant of the class to which this object is to be changed.
Throws:
E_NULL_OR_INVALID_PARAM_VALUE - if className is null or has a length of zero.


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