com.filenet.api.admin
Interface EventQueueItem

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, QueueItem, RepositoryObject, java.io.Serializable

public interface EventQueueItem
extends RepositoryObject, QueueItem

Represents a pending (queued) execution of an asynchronous event action, or an asynchronous event queue item that remains unprocessed because its retry count is zero. The EventQueueItem interface includes properties for setting and retrieving the source object and event of the pending event action.

To instantiate an EventQueueItem object, call the getInstance or fetchInstance method on the Factory.EventQueueItem class.

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: ClassDefinition
IsDependent: false
IsHidden: true
Name: Id
Searchable: true
StorageType: ObjectStore
SuperclassName: QueueItem


Method Summary
 Event get_EventObject()
          Returns the value of the EventObject property.
 IndependentObject get_QueuedObject()
          Returns the value of the QueuedObject property.
 IndependentObject get_SourceObject()
          Returns the value of the SourceObject property.
 void set_EventObject(Event value)
          Sets the value of the EventObject property.
 void set_QueuedObject(IndependentObject value)
          Sets the value of the QueuedObject property.
 void set_SourceObject(IndependentObject value)
          Sets the value of the SourceObject property.
 
Methods inherited from interface com.filenet.api.admin.QueueItem
get_Creator, get_DateCreated, get_DateLastModified, get_DequeueHost, get_Id, get_LastModifier, get_NextRetryDate, get_RetryCount, set_Creator, set_DateCreated, set_DateLastModified, set_LastModifier, set_RetryCount
 
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_QueuedObject

IndependentObject get_QueuedObject()
Returns the value of the QueuedObject property. For more information, see QueuedObject Property.


set_QueuedObject

void set_QueuedObject(IndependentObject value)
Sets the value of the QueuedObject property. For more information, see QueuedObject Property.


get_SourceObject

IndependentObject get_SourceObject()
Returns the value of the SourceObject property. For more information, see SourceObject Property.


set_SourceObject

void set_SourceObject(IndependentObject value)
Sets the value of the SourceObject property. For more information, see SourceObject Property.


get_EventObject

Event get_EventObject()
Returns the value of the EventObject property. For more information, see EventObject Property.


set_EventObject

void set_EventObject(Event value)
Sets the value of the EventObject property. For more information, see EventObject Property.



© Copyright IBM Corporation 2006, 2008. All rights reserved.