public interface CmBackgroundSearch extends RepositoryObject, CmSweep
CmBackgroundSearch
class is derived from
the CmSweep
class and its instances are stored in the Sweep table.
The base CmBackgroundSearch
class cannot be instantiated.
After you define a background search in a CmBackgroundSearch
subclass, you
start the background search by instantiating the subclass, providing values to those object
properties that define parameters, and saving the object.
To define the search expression of the background search, set the default value of the
SearchExpression property definition of a CmBackgroundSearch
subclass definition to a
valid Content Platform Engine SQL expression. This SQL expression has a syntax extension for specifying
parameter substitution. Parameters are defined by custom properties that you add to a
CmBackgroundSearch
subclass to define a particular search. The name of each parameter
must match the symbolic name of a custom property.
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
get_AllowStringTruncation()
Returns the value of the AllowStringTruncation 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.lang.String |
get_EffectiveSQL()
Returns the value of the EffectiveSQL property.
|
java.util.Date |
get_EffectiveStartDate()
Returns the value of the EffectiveStartDate property.
|
java.lang.Integer |
get_FailureCount()
Returns the value of the FailureCount property.
|
java.lang.Boolean |
get_IsEnabled()
Returns the value of the IsEnabled property.
|
java.lang.String |
get_LastFailureReason()
Returns the value of the LastFailureReason property.
|
java.lang.Integer |
get_MaximumExaminedRowCount()
Returns the value of the MaximumExaminedRowCount property.
|
java.lang.Integer |
get_MaximumFailures()
Returns the value of the MaximumFailures property.
|
java.lang.Boolean |
get_OrderByGroupedProperties()
Returns the value of the OrderByGroupedProperties property.
|
java.lang.String |
get_SearchExpression()
Returns the value of the SearchExpression property.
|
ObjectStore |
get_SearchObjectStore()
Returns the value of the SearchObjectStore property.
|
CmAbstractSearchResultSet |
get_SearchResults()
Returns the value of the SearchResults 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_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_FailureCount(java.lang.Integer value)
Sets the value of the FailureCount property.
|
void |
set_IsEnabled(java.lang.Boolean value)
Sets the value of the IsEnabled property.
|
void |
set_MaximumExaminedRowCount(java.lang.Integer value)
Sets the value of the MaximumExaminedRowCount property.
|
void |
set_MaximumFailures(java.lang.Integer value)
Sets the value of the MaximumFailures property.
|
void |
set_SearchObjectStore(ObjectStore value)
Sets the value of the SearchObjectStore 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.
|
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
getObjectStore
raiseEvent
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
java.lang.String get_DisplayName()
void set_DisplayName(java.lang.String value)
java.util.Date get_EffectiveStartDate()
void set_EffectiveStartDate(java.util.Date value)
java.util.Date get_EffectiveEndDate()
void set_EffectiveEndDate(java.util.Date value)
java.lang.Boolean get_IsEnabled()
void set_IsEnabled(java.lang.Boolean value)
java.lang.Integer get_SweepRetryWaitInterval()
void set_SweepRetryWaitInterval(java.lang.Integer value)
java.lang.Integer get_SweepBatchSize()
void set_SweepBatchSize(java.lang.Integer value)
java.lang.Integer get_MaximumFailures()
void set_MaximumFailures(java.lang.Integer value)
java.lang.String get_SearchExpression()
CmAbstractSearchResultSet get_SearchResults()
java.lang.String get_EffectiveSQL()
java.lang.Integer get_FailureCount()
void set_FailureCount(java.lang.Integer value)
java.lang.String get_LastFailureReason()
ObjectStore get_SearchObjectStore()
void set_SearchObjectStore(ObjectStore value)
java.lang.Boolean get_AllowStringTruncation()
java.lang.Boolean get_OrderByGroupedProperties()
java.lang.Integer get_MaximumExaminedRowCount()
void set_MaximumExaminedRowCount(java.lang.Integer value)
© Copyright IBM Corporation 2006, 2015. All rights reserved.