com.filenet.api.events

Interface ObjectChangeEvent

All Superinterfaces:

EngineObject, Event, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable

All Known Subinterfaces:

CancelCheckoutEvent, ChangeClassEvent, ChangeStateEvent, CheckinEvent, CheckoutEvent, ClassifyCompleteEvent, CmMarkForDeletionEvent, CmMoveContentEvent, CmRecoverEvent, CreationEvent, CustomEvent, DeletionEvent, DemoteVersionEvent, FileEvent, FreezeEvent, LockEvent, PromoteVersionEvent, TakeFederatedOwnershipEvent, UnfileEvent, UnlockEvent, UpdateEvent, UpdateSecurityEvent

public interface ObjectChangeEvent
extends RepositoryObject, Event

Represents an event that occurs when the state of an object is changed. This interface is the base for several event interfaces.

Note that an instance of ObjectChangeEvent or any of its subclasses can be extended with audited custom properties of the source object of the event. A source object's properties are audited under the following conditions:

• Auditing is enabled on the object store.
• The AuditAs property is set on one or more property definitions of the source object's class definition.
• One or more audit definitions are set with the events to be audited.

For more information, see Property Auditing.

You can instantiate an ObjectChangeEvent object with the getInstance or fetchInstance method on the Factory.ObjectChangeEvent class.

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: EventClassDefinition
IsDependent: false
IsHidden: false
Searchable: true
StorageType: ObjectStore
SuperclassName: Event

Method Summary

Modifier and Type	Method and Description
Id	get_SourceClassId() Returns the value of the SourceClassId property.
IndependentObject	get_SourceObject() Returns the value of the SourceObject property.
Id	get_SourceObjectId() Returns the value of the SourceObjectId property.

Methods inherited from interface com.filenet.api.events.Event

get_CmAuditSequence, get_Creator, get_DateCreated, get_DateLastModified, get_EventStatus, get_Id, get_InitiatingUser, get_LastModifier, get_Name, get_Owner, get_Permissions, set_Creator, set_DateCreated, set_DateLastModified, set_EventStatus, set_LastModifier, set_Owner, set_Permissions

Methods inherited from interface com.filenet.api.core.RepositoryObject

getObjectStore

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject

fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_SourceClassId

Id get_SourceClassId()

Returns the value of the SourceClassId property. For more information, see SourceClassId Property.

get_SourceObjectId

Id get_SourceObjectId()

Returns the value of the SourceObjectId property. For more information, see SourceObjectId Property.

get_SourceObject

IndependentObject get_SourceObject()

Returns the value of the SourceObject property. For more information, see SourceObject Property.