com.filenet.api.events

Interface FileEvent

All Superinterfaces:

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

public interface FileEvent
extends RepositoryObject, ObjectChangeEvent

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. The source object of this event is the Folder object. In the case of filing a document or custom object, the source object is the containing folder. In the case of creating a subfolder, the source object is the parent folder.

You can instantiate a FileEvent object in the following ways:

• Create a ReferentialContainmentRelationship (RCR) object. The Folder.file method mentioned above creates a RCR object.
• Call the getInstance or fetchInstance method on the Factory.FileEvent class.
• Call get_AuditedEvents on a Folder object, and iterate the EventSet collection for instances of FileEvent objects.
• Retrieve a FileEvent object from a FileEventSet collection.

Metadata

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	get_ContainmentName() Returns the value of the ContainmentName property.

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

get_SourceClassId, get_SourceObject, get_SourceObjectId

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_ContainmentName

java.lang.String get_ContainmentName()

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