Package com.filenet.api.events

Provides interfaces that represent events triggered on Content Engine objects, as well as interfaces that allow you to extend Content Engine functionality and invoke it through the event mechanism.

See:
          Description

Interface Summary
Action Represents an extensible, user-implemented action in response to an event triggered on a source object.
ActionConsumer Represents consumer of Action-based objects.
AuditConfigurationEvent Represents an event that occurs when the auditing configuration of an object store is changed.
CancelCheckoutEvent Represents an event that occurs when a reservation on a versionable object is canceled.
ChangeClassEvent Represents an event that occurs when the class of an object is changed.
ChangeStateEvent Represents an event that occurs when the lifecycle state of a Document object changes.
CheckinEvent Represents an event that occurs when a versionable object is checked in.
CheckoutEvent Represents an event that occurs when a versionable object is checked out.
ClassifyCompleteEvent Represents an event that occurs when a document has been auto-classified, that is, assigned a document class automatically during checkin.
ClassSubscription Represents a subscription for events generated by all objects of a particular class.
ClassWorkflowSubscription Represents a subscription that initiates a workflow in response to events generated by all objects of a particular class.
CreationEvent Represents an event that occurs when an object instance of a class is created and saved.
CustomEvent Represents a user-defined custom event.
DeletionEvent Represents an event that occurs when an object is deleted from the object store.
DemoteVersionEvent Represents an event that occurs when a versionable object is demoted to a minor version.
DocumentClassificationAction Defines the content type and the server-side Java implementation that automatically classifies a document of the defined content type.
DocumentLifecycleAction Represents the actions to be taken when a document's lifecycle state is changed.
DocumentLifecyclePolicy Represents the lifecycle policy for a document.
DocumentState Represents a valid lifecycle state of a document lifecycle policy.
Event Represents a system or custom event that can be triggered on an Content Engine object or class of objects.
EventAction Represents the actions taken when a subscribed event fires.
FileEvent 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 is called to create a subfolder.
FreezeEvent Represents an event that occurs when the freeze method of a Versionable object is successfully called.
GetContentEvent Represents an event that occurs when the content of a content-carrying object is retrieved.
GetObjectEvent Represents an event that occurs when an object is retrieved from the object store.
InstanceSubscription Represents a subscription for events generated by a single object instance of a particular class.
InstanceWorkflowSubscription Represents a subscription that initiates a workflow in response to events generated by a single object instance.
LockEvent 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.
ObjectChangeEvent Represents an event that occurs when the state of an object is changed.
PromoteVersionEvent Represents an event that occurs when a document is promoted or checked in as a major version.
PublishCompleteEvent Represents an event that occurs when a document-publishing request has completed.
PublishRequestEvent Represents an event that occurs when a request has been made to publish or republish a document.
QueryEvent Repesents an event that occurs whenever a database query is performed.
RetrievalEvent Represents an event that occurs when a Content Engine object or its content is retrieved or queried.
SubscribedEvent A SubscribedEvent object represents a system or custom event that applies to a Subscription object.
Subscription Represents a request to execute an event action when an event is triggered on a target Content Engine object.
TakeFederatedOwnershipEvent Event reported when the takeFederatedOwnership method is applied to a Document object.
UnfileEvent Represents an event that occurs when a folder has its unfile method called to remove (unfile) a Containable object, for example, a Document or Folder, or when the unfile method is called to delete a subfolder.
UnlockEvent Represents an event that occurs when the unlock method is called on a Document, CustomObject, or Folder object.
UpdateEvent Represents an event that occurs when changes are made to an object's properties.
UpdateSecurityEvent Represents an event that occurs when the security of an object is changed.
WorkflowEventAction Represents a definition of the actions taken when a workflow is initiated via an event that is subscribed to by a workflow subscription.
 

Package com.filenet.api.events Description

Provides interfaces that represent events triggered on Content Engine objects, as well as interfaces that allow you to extend Content Engine functionality and invoke it through the event mechanism. This package exposes audit- and subscription-related functionality. When an audited event or subscribed event occurs, the Content Engine API creates an event object. You can access the object's properties to get information about the event.

Most interfaces represent system events, which you can instantiate but not create through the API. The capability to create user-defined events is provided with the CustomEvent interface.

The Action interface and subinterfaces represent user-implemented actions in response to triggered events or changed document lifecycle states. ActionConsumer-based interfaces define the events or document lifecycle states under which user-implemented actions are invoked.



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