The following table lists the types derived from IObjectChangeEvent .

Derived Types

Type Description
ICancelCheckoutEvent Represents an event that occurs when a reservation on a versionable object is canceled.

You can instantiate a ICancelCheckoutEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.CancelCheckoutEvent class.
  • Retrieve the AuditedEvents property on a IDocument object, and iterate the IEventSet collection for instances of ICancelCheckoutEvent objects.
  • Retrieve a ICancelCheckoutEvent object from a ICancelCheckoutEventSet collection.
IChangeClassEvent Represents an event that occurs when the class of an object is changed.

You can instantiate a IChangeClassEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.ChangeClassEvent class.
  • Retrieve the AuditedEvents property on a IDocument, IFolder, or ICustomObject object, and iterate the IEventSet collection for instances of IChangeClassEvent objects.
  • Retrieve a IChangeClassEvent object from a IChangeClassEventSet collection.
IChangeStateEvent Represents an event that occurs when the lifecycle state of a Document object changes.

You can instantiate a IChangeStateEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.ChangeStateEvent class.
  • Retrieve the AuditedEvents property on a IDocument object, and iterate the IEventSet collection for instances of IChangeStateEvent objects.
  • Retrieve a IChangeStateEvent object from a IChangeStateEventSet collection.
ICheckinEvent Represents an event that occurs when a versionable object is checked in.

You can instantiate a ICheckinEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.CheckinEvent class.
  • Retrieve the AuditedEvents property on a IDocument object, and iterate the IEventSet collection for instances of ICheckinEvent objects.
  • Retrieve a ICheckinEvent object from a ICheckinEventSet collection.
ICheckoutEvent Represents an event that occurs when a versionable object is checked out.

You can instantiate a ICheckoutEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.CheckoutEvent class.
  • Retrieve the AuditedEvents property on a IDocument object, and iterate the IEventSet collection for instances of ICheckoutEvent objects.
  • Retrieve a ICheckoutEvent object from a ICheckoutEventSet collection.
IClassifyCompleteEvent Represents an event that occurs when a document has been auto-classified, that is, assigned a document class automatically during checkin.

You can instantiate a IClassifyCompleteEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.ClassifyCompleteEvent class.
  • Retrieve the AuditedEvents property on a IDocument object, and iterate the IEventSet collection for instances of IClassifyCompleteEvent objects.
  • Retrieve a IClassifyCompleteEvent object from a IClassifyCompleteEventSet collection.
Concepts: automatic document classifications
ICreationEvent Represents an event that occurs when an object instance of a class is created and saved.

You can instantiate a ICreationEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.CreationEvent class.
  • Retrieve the AuditedEvents property on a IDocument, IFolder, or ICustomObject object, and iterate the IEventSet collection for instances of ICreationEvent objects.
  • Retrieve a ICreationEvent object from a ICreationEventSet collection.
ICustomEvent Represents a user-defined custom event. A custom event is raised whenever an object to which it is subscribed calls its RaiseEvent method.

To create a CustomEvent object, and persist it to a Content Engine object store, call the CreateInstance method on the Factory.CustomEvent class.

You can instantiate a CustomEvent object in the following ways:

  • By calling the GetInstance or FetchInstance method on the Factory.CustomEvent class.
  • By retrieving the AuditedEvents property on the source object of the custom event, and iterating the EventSet collection for instances of CustomEvent objects.
  • By retrieving a CustomEvent object from a CustomEventSet collection.
IDeletionEvent Represents an event that occurs when an object is deleted from the object store.

You can instantiate a IDeletionEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.DeletionEvent class.
  • Retrieve the AuditedEvents property on a IDocument, IFolder, or ICustomObject object, and iterate the IEventSet collection for instances of IDeletionEvent objects.
  • Retrieve a IDeletionEvent object from a IDeletionEventSet collection.
IDemoteVersionEvent Represents an event that occurs when a versionable object is demoted to a minor version.

You can instantiate a IDemoteVersionEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.DemoteVersionEvent class.
  • Retrieve the AuditedEvents property on a IDocument object, and iterate the IEventSet collection for instances of IDemoteVersionEvent objects.
  • Retrieve a IDemoteVersionEvent object from a IDemoteVersionEventSet collection.
IFileEvent Represents an event that occurs when a folder has its File method called to file a Containable object, for example, a Document or CustomObject, or when the File method is called to create a subfolder.

You can instantiate a FileEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.FileEvent class.
  • Retrieve the AuditedEvents property on a Folder object, and iterate the EventSet collection for instances of FileEvent objects.
  • Retrieve a FileEvent object from a FileEventSet collection.
IFreezeEvent Represents an event that occurs when the Freeze method of a Versionable object is successfully called.

You can instantiate a IFreezeEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.FreezeEvent class.
  • Retrieve the AuditedEvents property on a IDocument object, and iterate the IEventSet collection for instances of IFreezeEvent objects.
  • Retrieve a IFreezeEvent object from a IFreezeEventSet collection.
ILockEvent Represents an event that occurs when the Lock method is called to lock or update an existing lock on a Document, CustomObject, or Folder object.

You can instantiate a LockEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.LockEvent class.
  • Retrieve the AuditedEvents property on a Document, Folder, or CustomObject object, and iterate the EventSet collection for instances of LockEvent objects.
  • Retrieve a LockEvent object from a LockEventSet collection.
IPromoteVersionEvent Represents an event that occurs when a document is promoted or checked in as a major version.

You can instantiate a PromoteVersionEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the PromoteVersionEvent class.
  • Retrieve the AuditedEvents property on a Document object, and iterate the EventSet collection for instances of PromoteVersionEvent objects.
  • Retrieve a PromoteVersionEvent object from a PromoteVersionEventSet collection.
IPublishCompleteEvent Represents an event that occurs when a document-publishing request has completed.

You can instantiate a PublishCompleteEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.PublishCompleteEvent class.
  • Retrieve the AuditedEvents property on a Document object, and iterate the EventSet collection for instances of PublishCompleteEvent objects.
  • Retrieve a PublishCompleteEvent object from a PublishCompleteEventSet collection.
IPublishRequestEvent interface.
IPublishRequestEvent Represents an event that occurs when a request has been made to publish or republish a document. A publish request is represented by a PublishRequest object.

You can instantiate a PublishRequestEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.PublishRequestEvent class.
  • Retrieve the AuditedEvents property on a Document object, and iterate the EventSet collection for instances of PublishRequestEvent objects.
  • Retrieve a PublishRequestEvent object from a PublishRequestEventSet collection.
ITakeFederatedOwnershipEvent Event reported when the TakeFederatedOwnership method is applied to a Document object.

You can instantiate a TakeFederatedOwnershipEvent object in the following ways:

IUnfileEvent Represents an event that occurs when a folder has its Unfile method called to remove (unfile) a Containable object, for example, a Document or CustomObject, or when the Unfile method is called to delete a subfolder.

You can instantiate an UnfileEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.UnfileEvent class.
  • Retrieve the AuditedEvents property on a Folder object, and iterate the EventSet collection for instances of UnfileEvent objects.
  • Retrieve an UnfileEvent object from an UnfileEventSet collection.
IUnlockEvent Represents an event that occurs when the Unlock method is called on a Document, CustomObject, or Folder object.

You can instantiate a UnlockEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.UnlockEvent class.
  • Retrieve the AuditedEvents property on a Document, Folder, or CustomObject object, and iterate the EventSet collection for instances of UnlockEvent objects.
  • Retrieve a UnlockEvent object from a UnlockEventSet collection.
IUpdateEvent Represents an event that occurs when changes are made to an object's properties.

You can instantiate a UpdateEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.UpdateEvent class.
  • Retrieve the AuditedEvents property on a Document, Folder, or CustomObject object, and iterate the EventSet collection for instances of UpdateEvent objects.
  • Retrieve an UpdateEvent object from an UpdateEventSet collection.
IUpdateSecurityEvent Represents an event that occurs when the security of an object is changed.

Note that the dynamic inheritance feature of the Content Engine security model impacts UpdateSecurityEvent as follows. First, modifying the security of a folder will not automatically propogate to the documents contained in the folder; that is, the security of the documents in the folder will not change. Therefore, the system will generate an UpdateSecurityEvent object for the folder, but it will not generate an UpdateSecurityEvent object for each contained document. Second, an update to any object-valued property designated as inheritable in the metadata will generate an UpdateSecurityEvent object .

You can instantiate a UpdateSecurityEvent object in the following ways:

  • Call the GetInstance or FetchInstance method on the Factory.UpdateSecurityEvent class.
  • Retrieve the AuditedEvents property on a Document, Folder, or CustomObject object, and iterate the EventSet collection for instances of UpdateSecurityEvent objects.
  • Retrieve a UpdateSecurityEvent object from a UpdateSecurityEventSet collection.

See Also