Content Engine Java API: RaiseEvent

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.filenet.api.action.PendingAction
- - com.filenet.api.action.RaiseEvent

All Implemented Interfaces:

java.io.Serializable
```
public class RaiseEvent
extends PendingAction
```
Represents a pending action for raising a custom event on a Subscribable object. When you call the RaiseEvent method, an instance of the RaiseEvent class is created and added to the Subscribable object's collection of PendingAction objects.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

RaiseEvent(Properties props, java.lang.String classId)
Creates a new instance of a RaiseEvent pending action object.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getClassId()` Returns a class identifier of the custom event to be created for this pending action.
`Properties`	`getEventProperties()` Returns the properties of the custom event object to be raised.

Methods inherited from class com.filenet.api.action.PendingAction
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RaiseEvent
```
public RaiseEvent(Properties props,
          java.lang.String classId)
```
    Creates a new instance of a RaiseEvent pending action object.
    
    Parameters:
    props - A Properties collection that specifies the properties to set for the custom event. The collection must include the ID property of the CustomEvent object.
    classId - A String specifying the name of the class. If null, or if the custom event class does not exist, this constructor throws an exception.
- Method Detail
  - getEventProperties
```
public Properties getEventProperties()
```
    Returns the properties of the custom event object to be raised.
    
    Returns:
    A Properties collection containing the custom event object's properties.
  - getClassId
```
public java.lang.String getClassId()
```
    Returns a class identifier of the custom event to be created for this pending action.
    
    Returns:
    A String containing the class identifier.