com.filenet.api.sweep

Interface CmAbstractSearchResult

All Superinterfaces:

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

public interface CmAbstractSearchResult
extends RepositoryObject, IndependentlyPersistableObject

The abstract, base class from which you create a subclass to define the class of objects that are returned in a background search result. This CmAbstractSearchResult subclass defines the custom properties to receive SQL select statement query result values from a background search. For each of these custom properties, set the settability property to SETTABLE_ONLY_ON_CREATE and, for object-valued properties, set the DeletionAction property to NONE.

When a background search executes, instances of the CmAbstractSearchResult subclass that you defined are created and populated with the properties that are selected in the background search query, one instance per result row from the search. Properties are matched by name: the name of a property object in the result row properties collection is matched to the symbolic name of a custom property that is defined in the CmAbstractSearchResult subclass.

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: true
ClassDefinitionName: ClassDefinition
IsDependent: false
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject

Method Summary

Modifier and Type	Method and Description
CmBackgroundSearch	get_BackgroundSearch() Returns the value of the BackgroundSearch 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.
Id	get_Id() Returns the value of the Id property.
java.lang.String	get_LastModifier() Returns the value of the LastModifier property.
void	set_BackgroundSearch(CmBackgroundSearch value) Sets the value of the BackgroundSearch 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_LastModifier(java.lang.String value) Sets the value of the LastModifier property.

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

getObjectStore

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_BackgroundSearch

CmBackgroundSearch get_BackgroundSearch()

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

set_BackgroundSearch

void set_BackgroundSearch(CmBackgroundSearch value)

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