com.filenet.api.sweep

Interface CmQueueSweep

All Superinterfaces:

CmSweep, EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable

All Known Subinterfaces:

CmCustomQueueSweep, CmThumbnailRequestSweep

public interface CmQueueSweep
extends RepositoryObject, CmSweep

Abstract base class for sweep instances that are optimized for ongoing processing of queue tables.

Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweep

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	get_CurrentExaminedObjectCount() Returns the value of the CurrentExaminedObjectCount property.
java.lang.Double	get_CurrentFailedObjectCount() Returns the value of the CurrentFailedObjectCount property.
java.lang.Double	get_CurrentProcessedObjectCount() Returns the value of the CurrentProcessedObjectCount 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.
java.util.Date	get_EffectiveEndDate() Returns the value of the EffectiveEndDate property.
java.util.Date	get_EffectiveStartDate() Returns the value of the EffectiveStartDate property.
java.lang.Boolean	get_IsEnabled() Returns the value of the IsEnabled property.
java.lang.Integer	get_MaximumFailures() Returns the value of the MaximumFailures property.
java.lang.Integer	get_SweepBatchSize() Returns the value of the SweepBatchSize property.
java.lang.Integer	get_SweepRetryWaitInterval() Returns the value of the SweepRetryWaitInterval 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_EffectiveEndDate(java.util.Date value) Sets the value of the EffectiveEndDate property.
void	set_EffectiveStartDate(java.util.Date value) Sets the value of the EffectiveStartDate property.
void	set_IsEnabled(java.lang.Boolean value) Sets the value of the IsEnabled property.
void	set_MaximumFailures(java.lang.Integer value) Sets the value of the MaximumFailures property.
void	set_SweepBatchSize(java.lang.Integer value) Sets the value of the SweepBatchSize property.
void	set_SweepRetryWaitInterval(java.lang.Integer value) Sets the value of the SweepRetryWaitInterval property.

Methods inherited from interface com.filenet.api.sweep.CmSweep

get_AuditedEvents, get_Creator, get_DateCreated, get_DateLastModified, get_ExaminedObjectCount, get_FailedObjectCount, get_Id, get_InterBatchDelay, get_LastModifier, get_MaxSweepWorkers, get_Owner, get_Permissions, get_ProcessedObjectCount, get_SweepEndDate, get_SweepStartDate, get_SweepTarget, get_SweepTimeslots, set_Creator, set_DateCreated, set_DateLastModified, set_InterBatchDelay, set_LastModifier, set_MaxSweepWorkers, set_Owner, set_Permissions, set_SweepTarget, set_SweepTimeslots

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

getObjectStore

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_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_EffectiveStartDate

java.util.Date get_EffectiveStartDate()

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

set_EffectiveStartDate

void set_EffectiveStartDate(java.util.Date value)

Sets the value of the EffectiveStartDate property. For more information, see EffectiveStartDate Property.

get_EffectiveEndDate

java.util.Date get_EffectiveEndDate()

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

set_EffectiveEndDate

void set_EffectiveEndDate(java.util.Date value)

Sets the value of the EffectiveEndDate property. For more information, see EffectiveEndDate Property.

get_IsEnabled

java.lang.Boolean get_IsEnabled()

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

set_IsEnabled

void set_IsEnabled(java.lang.Boolean value)

Sets the value of the IsEnabled property. For more information, see IsEnabled Property.

get_MaximumFailures

java.lang.Integer get_MaximumFailures()

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

set_MaximumFailures

void set_MaximumFailures(java.lang.Integer value)

Sets the value of the MaximumFailures property. For more information, see MaximumFailures Property.

get_SweepRetryWaitInterval

java.lang.Integer get_SweepRetryWaitInterval()

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

set_SweepRetryWaitInterval

void set_SweepRetryWaitInterval(java.lang.Integer value)

Sets the value of the SweepRetryWaitInterval property. For more information, see SweepRetryWaitInterval Property.

get_SweepBatchSize

java.lang.Integer get_SweepBatchSize()

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

set_SweepBatchSize

void set_SweepBatchSize(java.lang.Integer value)

Sets the value of the SweepBatchSize property. For more information, see SweepBatchSize Property.

get_CurrentExaminedObjectCount

java.lang.Double get_CurrentExaminedObjectCount()

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

get_CurrentProcessedObjectCount

java.lang.Double get_CurrentProcessedObjectCount()

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

get_CurrentFailedObjectCount

java.lang.Double get_CurrentFailedObjectCount()

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