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:

  • Call the GetInstance or FetchInstance method on the Factory.EventAction class.
  • Get the EventActions property on an ObjectStore, and iterate the EventActionSet collection.
  • Call the get_ReferencingActions method on a CodeModule, and iterate the ActionSet collection for instances of EventAction objects.
  • Get the EventAction property on a Subscription object or subobject.

The following tables list the members exposed by IEventAction.

Public Properties

 NameDescription
Public propertyIsEnabledIndicates whether a given object is enabled or disabled. For example, you can globally disable or enable active events by setting an IEventAction object's IsEnabled property to False (off) or True (on). Likewise, you can enable or disable a subscription or a security template. Enabling a security template indicates that it can be applied to an object. A disabled security template remains part of its security policy container, but cannot be applied to an object. Disabling a security template is useful when you are testing or developing the security templates that make up a security policy. Disabling a subscription prevents the function associated with the event from being loaded and executed. You might want to disable a subscription that is undergoing modifications due to a change in business processes or when you do not want functions to execute against federated documents. Note that when you disable an IEventAction, all of its associated subscriptions are also disabled. However, when you disable one particular ISubscription, you only disable events that are in its subscribed event list.
Public propertySubscriptionsA collection of the subscriptions associated with this object.
Top

Public Methods

 NameDescription
Public methodChangeClassChanges 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:
  • Any user-defined properties that exist in the new class but not in the original class are set to the default value defined by the new class (or to null if there is no default defined).
  • Any user-defined properties that exist in both the original and the new class that are writable and have the same value (including null) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class.
  • Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.

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:

  • The document has no current lifecycle policy.
  • The document is either a reservation object, or is the current version object and is not reserved.

Top

See Also