com.filenet.api.events
Interface Action
-
- All Superinterfaces:
- EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
- All Known Subinterfaces:
- CmChangePreprocessorAction, CmContentConversionAction, CmSearchFunctionDefinition, CmSweepAction, CmTextIndexingPreprocessorAction, DocumentClassificationAction, DocumentLifecycleAction, EventAction, WorkflowEventAction
public interface Action extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
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. The API provides handler subinterfaces that you implement with the actions to be taken, coded as JavaScript or Java components.An
Action
-based object identifies an implemented handler with the ProgId property. A JavaScript-implemented handler is set on the ScriptText property. A Java-implemented handler (JAR or class file) can be checked into a Content Engine object store as aCodeModule
object, requiring that the CodeModule property be set. Alternatively, you can set the location of the Java component in the class path of the application server.Metadata
-
-
Method Summary
Methods Modifier and Type Method and Description ActiveMarkingList
get_ActiveMarkings()
Returns the value of the ActiveMarkings property.EventSet
get_AuditedEvents()
Returns the value of the AuditedEvents property.CodeModule
get_CodeModule()
Returns the value of the CodeModule property.java.lang.String
get_Creator()
Returns the value of the Creator property.java.util.Date
get_DateCreated()
Returns the value of the DateCreated property.java.util.Date
get_DateLastModified()
Returns the value of the DateLastModified property.java.lang.String
get_DescriptiveText()
Returns the value of the DescriptiveText property.java.lang.String
get_DisplayName()
Returns the value of the DisplayName property.Id
get_Id()
Returns the value of the Id property.java.lang.String
get_LastModifier()
Returns the value of the LastModifier property.java.lang.String
get_Name()
Returns the value of the Name property.java.lang.String
get_Owner()
Returns the value of the Owner property.AccessPermissionList
get_Permissions()
Returns the value of the Permissions property.java.lang.String
get_ProgId()
Returns the value of the ProgId property.java.lang.String
get_ScriptText()
Returns the value of the ScriptText property.void
set_CodeModule(CodeModule value)
Sets the value of the CodeModule property.void
set_Creator(java.lang.String value)
Sets the value of the Creator property.void
set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property.void
set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property.void
set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property.void
set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property.void
set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property.void
set_Owner(java.lang.String value)
Sets the value of the Owner property.void
set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property.void
set_ProgId(java.lang.String value)
Sets the value of the ProgId property.void
set_ScriptText(java.lang.String value)
Sets the value of the ScriptText property.-
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
-
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
-
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
-
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_Creator
java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.
-
set_Creator
void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.
-
get_DateCreated
java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.
-
set_DateCreated
void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.
-
get_LastModifier
java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.
-
set_LastModifier
void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.
-
get_DateLastModified
java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
-
set_DateLastModified
void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
-
get_Id
Id get_Id()
Returns the value of the Id property. For more information, see Id Property.
-
get_Name
java.lang.String get_Name()
Returns the value of the Name property. For more information, see Name Property.
-
get_AuditedEvents
EventSet get_AuditedEvents()
Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.
-
get_Owner
java.lang.String get_Owner()
Returns the value of the Owner property. For more information, see Owner Property.
-
set_Owner
void set_Owner(java.lang.String value)
Sets the value of the Owner property. For more information, see Owner Property.
-
get_Permissions
AccessPermissionList get_Permissions()
Returns the value of the Permissions property. For more information, see Permissions Property.
-
set_Permissions
void set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. For more information, see Permissions Property.
-
get_ActiveMarkings
ActiveMarkingList get_ActiveMarkings()
Returns the value of the ActiveMarkings property. For more information, see ActiveMarkings Property.
-
get_DisplayName
java.lang.String get_DisplayName()
Returns the value of the DisplayName property. For more information, see DisplayName Property.
-
set_DisplayName
void set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property. For more information, see DisplayName Property.
-
get_DescriptiveText
java.lang.String get_DescriptiveText()
Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.
-
set_DescriptiveText
void set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.
-
get_ProgId
java.lang.String get_ProgId()
Returns the value of the ProgId property. For more information, see ProgId Property.
-
set_ProgId
void set_ProgId(java.lang.String value)
Sets the value of the ProgId property. For more information, see ProgId Property.
-
get_ScriptText
java.lang.String get_ScriptText()
Returns the value of the ScriptText property. For more information, see ScriptText Property.
-
set_ScriptText
void set_ScriptText(java.lang.String value)
Sets the value of the ScriptText property. For more information, see ScriptText Property.
-
get_CodeModule
CodeModule get_CodeModule()
Returns the value of the CodeModule property. For more information, see CodeModule Property.
-
set_CodeModule
void set_CodeModule(CodeModule value)
Sets the value of the CodeModule property. For more information, see CodeModule Property.
-
-