| Interface | Description |
---|
 | IAction | Represents an extensible, user-implemented action in response to an event triggered on a source object. This interface is the base for subinterfaces representing implemented actions to be taken for specific events, such as changing a document's lifecycle or deleting an object. The Content Engine Java API provides event handling interfaces that you must implement with the actions to be taken, coded as a Java module. You link an IAction -based object to an implemented event handler by setting the ProdId property. If you check in the Java module to a Content Engine object store, you must set the CodeModule property as well (see ICodeModule). Instead of checking in the Java module, you can set its location in the class path of the application server. See also the Javadocs for the following interfaces: DocumentClassifier , DocumentLifecycleActionHandler , EventActionHandler |
 | IActionConsumer | Represents the consumer of Action-based objects. This interface is the base for subinterfaces representing specific consumers, namely, ISubscription -based interfaces and IDocumentLifecyclePolicy . Generally speaking, IActionConsumer objects enable user-implemented actions to execute when specified events fire on a specified Content Engine object. You can instantiate a persisted IActionConsumer object by calling the getInstance or fetchInstance method on the Factory.ActionConsumer class. See also the help for the following interfaces: DocumentClassifier , DocumentLifecycleActionHandler , EventActionHandler . |
 | IAuditConfigurationEvent | Represents an event that occurs when the auditing configuration of an object store is changed. Auditing is either enabled or disabled by setting the AuditLevel property on IObjectStore , and the IAuditConfigurationEvent object is saved. You can instantiate a IAuditConfigurationEvent object in the following ways: |
 | 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 |
 | IClassSubscription | Represents a subscription for events generated by all objects of a particular class. The target for these subscriptions must be a class definition. To create a IClassSubscription object, call the CreateInstance method on the Factory.ClassSubscription class. You can instantiate a persisted IClassSubscription object in the following ways: - By calling the
GetInstance or FetchInstance method on the Factory.ClassSubscription class. - By instantiating a ISubscriptionSet collection, then returning a
IClassSubscription object from the collection.
|
 | IClassWorkflowSubscription | Represents a subscription that initiates a workflow in response to events generated by all objects of a particular class. A IClassWorkflowSubscription object provides object properties to link a workflow (IWorkflowDefinition), a target object, and one or more events (ISubscribedEvent) that can be triggered on the target object. These objects must exist before you can create a IClassWorkflowSubscription object and persist it. To create a IClassWorkflowSubscription object, call the createInstance method on the Factory.ClassWorkflowSubscription class. You can instantiate a persisted IClassWorkflowSubscription object in the following ways: - By calling the
GetInstance or FetchInstance method on the Factory.ClassWorkflowSubscription class. - By instantiating a ISubscriptionSet collection, then returning a
IClassWorkflowSubscription object from the collection. - By getting the
WorkflowSubscriptions property on an IClassDefinition object, then iterating the IClassWorkflowSubscriptionSet collection.
|
 | 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.
|
 | IDocumentClassificationAction | Defines the content type and the server-side Java implementation that automatically classifies a document of the defined content type. You must create the Java classifier by implementing the DocumentClassifier interface. To specify the content type of the documents for which a IDocumentClassificationAction object will apply, set the MimeType property. To specify the implemented Java classifier, set the ProgId property. Each IDocumentClassificationAction object that you create and save in a given object store is automatically added to the object store's collection of IDocumentClassificationAction objects. |
 | IDocumentLifecycleAction | Represents the actions to be taken when a document's lifecycle state is changed. A document's lifecycle states are defined in the DocumentStates collection of its associated DocumentLifecyclePolicy object. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken when a document's lifecycle state changes. To change the lifecycle state of a document, call its ChangeState method; you can change a document's current lifecycle state to another predefined state, set it to an exception state, or clear it from an exception state by specifying the appropriate LifecycleChangeFlags constant in the flags parameter. To define the actions to take when a document’s lifecycle state is changed, write a Java handler class that implements the DocumentLifecycleActionHandler interface and code the actions to be taken for each type of lifecycle state change in the appropriate method. After you have finished writing the Java handler, you have two choices: - Check in the Java handler as a document and create a
CodeModule object (using its CreateInstance factory method). Set the CodeModule property of the DocumentLifecycleAction object to the document that you checked in, and cast it as a CodeModule object. - Specify the Java handler in the classpath of your application server (it is not necessary to create a
CodeModule object).
Lastly, set the ProgId property of the DocumentLifecycleAction object to the fully qualified package and class name of the Java handler. |
 | IDocumentLifecyclePolicy | Represents the lifecycle policy for a document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken and which access permissions to be applied when a document's lifecycle state changes. To define the lifecycle states in a document lifecycle policy, create a DocumentState object for each lifecycle state that you want to define and add it to the DocumentStateList collection referenced by the DocumentState property. You can set the ResetLifecycleOnCheckin property to define whether a document, when it is checked in, is reset to the initial lifecycle state in its document lifecycle policy or not. To define the actions to be taken when a document's lifecycle state changes, create a DocumentLifecycleAction object and set the DocumentLifecycleAction property to reference it. With the PreseveDirectPermissions property, you can elect to either preserve a document's direct (non-inherited) access permissions or replace them with the document lifecycle policy's access permissions. |
 | IDocumentState | Represents a valid lifecycle state of a document lifecycle policy. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken and which access permissions to be applied when a document's lifecycle state changes. To define the lifecycle states in a document lifecycle policy, create a DocumentState object for each lifecycle state that you want to define and add it to a DocumentLifecyclePolicy object's DocumentStates collection. Each lifecycle state must have a name, which is set by the StateName property. Each lifecycle state name must be unique within the lifecycle policy in which it is defined. To specify whether a given lifecycle state can be demoted or not, set its CanBeDemoted property. The order of the lifecycle states in a document lifecycle policy's DocumentStates collection is important and determines the succession of lifecycle states. When a document that is associated with a document lifecycle policy is created, its initial lifecycle state is the first DocumentState object in the document lifecycle policy's DocumentStates collection. To move a document into the next lifecycle state defined in the document lifecycle policy's DocumentStates collection, call the document's ChangeState method and set its flags parameter to the LifecycleChangeFlags.PROMOTE constant. To move a document into the previous lifecycle state (unless the document's current lifecycle state's CanBeDemoted property is set to false ), set the method's flags parameter to DEMOTE . The template permissions specified by the TemplatePermissions property will be applied during a lifecycle state change if you set the ApplyTemplatePermissions property to true ; otherwise the permissions will not be applied. If the ApplyTemplatePermissions property to set to true and you reset a document's lifecycle state, either by calling its ChangeState method and specifying RESET or by calling its Checkin method while the ResetLifecycleOnCheckin property on its document lifecycle policy is set to true , the access permissions will be reset to the access permissions of the initial lifecycle state. |
 | IEvent | Represents a system or custom event that can be triggered on an Content Engine object or class of objects. This is the base event interface from which several subinterfaces derive, used primarily for auditing and subscriptions. You can audit all event types, and you can subscribe to all events with the exception of those that derive from the RetrievalEvent interface. Through an event object, you can retrieve information about the object on which the event was fired, such as its permissions and the date the object was last modified. You can set some properties as well, if you have been granted privileged write access. |
 | IEventAction | 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.
|
 | 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.
|
 | IGetContentEvent | Represents an event that occurs when the content of a content-carrying object is retrieved. This event can only be audited; you cannot subscribe to it. You can instantiate a GetContentEvent object in the following ways: - Call the
GetInstance or FetchInstance method on the Factory.GetContentEvent class. - Retrieve the
AuditedEvents property on a Document object, and iterate the EventSet collection for instances of GetContentEvent objects. - Retrieve a
GetContentEvent object from a GetContentEventSet collection.
|
 | IGetObjectEvent | Represents an event that occurs when an object is retrieved from the object store. This event can only be audited; you cannot subscribe to it. You can instantiate a GetObjectEvent object in the following ways: - Call the
GetInstance or FetchInstance method on the Factory.GetObjectEvent class. - Retrieve the
AuditedEvents property on a RepositoryObject subclass, and iterate the EventSet collection for instances of GetObjectEvent objects. - Retrieve a
GetObjectEvent object from a GetObjectEventSet collection.
|
 | IInstanceSubscription | Represents a subscription for events generated by a single object instance of a particular class. To create a IInstanceSubscription object, call the CreateInstance method on the Factory.InstanceSubscription class. You can instantiate a persisted IInstanceSubscription object in the following ways: - By calling the
GetInstance or FetchInstance method on the Factory.InstanceSubscription class. - By instantiating a ISubscriptionSet collection, then returning a
IInstanceSubscription object from the collection.
|
 | IInstanceWorkflowSubscription | Represents a subscription that initiates a workflow in response to events generated by a single object instance. A InstanceWorkflowSubscription object provides object properties to link a workflow (WorkflowDefinition), a target object, and one or more events (SubscribedEvent) that can be triggered on the target object. These objects must exist before you can create a InstanceWorkflowSubscription object and persist it. To create a InstanceWorkflowSubscription object, call the CreateInstance method on the Factory.InstanceWorkflowSubscription class. You can instantiate a persisted InstanceWorkflowSubscription object in the following ways: |
 | 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.
|
 | IObjectChangeEvent | Represents an event that occurs when the state of an object is changed. This interface is the base for several event interfaces. You can instantiate a IObjectChangeEvent object in the following ways: |
 | 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.
|
 | IQueryEvent | Repesents an event that occurs whenever a database query is performed. This event can only be audited; you cannot subscribe to it. You can instantiate a QueryEvent object in the following ways: |
 | IRetrievalEvent | Represents an event that occurs when a Content Engine object or its content is retrieved or queried. This interface is the base for other event interfaces. These events cannot be subscribed to; they can only be audited. You can instantiate a RetrievalEvent object in the following ways: |
 | ISubscribedEvent | A ISubscribedEvent object represents a system or custom event that applies to a ISubscription object. You add a ISubscribedEvent object to a subscription via the ISubscription object's SubscribedEvents property. You set this property to a ISubscribedEventList collection. To create a ISubscribedEvent object, call the CreateInstance method on the Factory.SubscribedEvent class. You then set the object's EventClass property to a IEventClassDefinition object. You can get a reference to a SubscribedEvent object by iterating a ISubscribedEventList collection. |
 | ISubscription | Represents a request to execute an event action when an event is triggered on a target Content Engine object. For example, you can have a subscription that notifies you by email when documents of a certain class are created and saved in the object store. The specified EventAction and Subscribable objects, which represent the event action and target object, must exist before you can create a Subscription object and persist it. Subscription is the base class for subclasses defined with specialized behavior. You can create objects for the subclasses, but you cannot create a base Subscription object. You can, however, instantiate one in the following ways:
- By calling the
GetInstance or FetchInstance method on the Factory.Subscription class. - By getting the
Subscriptions property on an ObjectStore object or an EventAction object, then iterating the SubscriptionSet collection. - By getting the
WorkflowSourceSubscriptions property on a WorkflowDefinition object, then iterating the SubscriptionSet 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.
|
 | IWorkflowEventAction | Represents a definition of the actions taken when a workflow is initiated via an event that is subscribed to by a workflow subscription. To create a WorkflowEventAction object and persist it to a Content Engine object store, call the CreateInstance method on the Factory.WorkflowEventAction class. You can instantiate a WorkflowEventAction object in the following ways: |