Package | Description |
---|---|
com.filenet.api.admin |
Provides classes and interfaces that are used in the administration of a FileNet P8 Content Engine Server.
|
com.filenet.api.core |
Provides classes and interfaces that are related to the core business objects of the API, such as
EntireNetwork , Domain , Document , Folder , and so on. |
com.filenet.api.engine |
Provides interfaces and classes related to EventActions and other non-FileNet code which runs within the Content Engine itself.
|
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.
|
com.filenet.api.sweep |
Provides classes and interfaces for the sweep framework, a background service that visits a specified class and processes the instances that meet a specified criteria.
|
Class and Description |
---|
Action
Represents a server-extensible, user-implemented action in response to an
event triggered on a source object, or to an instance of a class definition getting created or updated.
|
CmChangePreprocessorAction
Defines the action to be taken when a change preprocessor is invoked
on a class definition.
|
Event
Represents a system or custom event that can be triggered on an Content Engine object or class of objects.
|
Class and Description |
---|
Action
Represents a server-extensible, user-implemented action in response to an
event triggered on a source object, or to an instance of a class definition getting created or updated.
|
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,
or when the state of a CmTask 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.
|
CmChangePreprocessorAction
Defines the action to be taken when a change preprocessor is invoked
on a class definition.
|
CmMarkForDeletionEvent
Represents an event that occurs when an object is marked for deletion.
|
CmMoveContentEvent
Event reported when the content of an object is moved.
|
CmRecoverEvent
Represents an event that occurs when an object marked for deletion is restored from a recovery bin.
|
CmThumbnailGenerationSubscription
Represents a subscription used to initiate event-based document thumbnail generation.
|
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
Associates a server-side document classifier with documents of a defined MIME 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 the
Folder.file method is called to file a
Containable object, for example, a Document ,
CustomObject , or when the Folder.createSubFolder method is called. |
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
Represents 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
CustomObject , or when a subfolder is deleted. |
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 the launching of a workflow when an event defined in a subscription is fired.
|
Class and Description |
---|
DocumentLifecyclePolicy
Represents the lifecycle policy for a document.
|
ObjectChangeEvent
Represents an event that occurs when the state of an object is changed.
|
RetrievalEvent
Represents an event that occurs when a
Content Engine object or its content is retrieved or queried.
|
Class and Description |
---|
Action
Represents a server-extensible, user-implemented action in response to an
event triggered on a source object, or to an instance of a class definition getting created or updated.
|
ActionConsumer
Represents consumer of
Action-based objects . |
ClassSubscription
Represents a subscription for events generated by all objects of a particular class.
|
DocumentLifecycleAction
Represents the actions to be taken when a document's lifecycle state is changed.
|
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.
|
InstanceSubscription
Represents a subscription for events generated by a single object instance of a particular class.
|
ObjectChangeEvent
Represents an event that occurs when the state of an object is changed.
|
RetrievalEvent
Represents an event that occurs when a
Content Engine object or its content is retrieved or queried.
|
Subscription
Represents a request to execute an event action when an event
is triggered on a target Content Engine object.
|
Class and Description |
---|
Action
Represents a server-extensible, user-implemented action in response to an
event triggered on a source object, or to an instance of a class definition getting created or updated.
|
© Copyright IBM Corporation 2006, 2015. All rights reserved.