SearchAndProcessItem SearchAndProcessItem SearchAndProcessItem Class

Definition

Represents the search and process operation that you want to execute, and includes a method to initiate the operation.

public ref class SearchAndProcessItem : Microsoft::Office::RecordsManagement::SearchAndProcess::SearchParameters
public class SearchAndProcessItem : Microsoft.Office.RecordsManagement.SearchAndProcess.SearchParameters
Public Class SearchAndProcessItem
Inherits SearchParameters
Inheritance
SearchAndProcessItemSearchAndProcessItemSearchAndProcessItem

Remarks

Search and process operations enable you to use Microsoft SharePoint Server 2010 to perform a search query, and then perform a specific, custom action upon each list item returned by the query. For example, you might need to identify a certain set of documents, based on specific document metadata, and then move those documents into a records repository.

The assembly you specify must implement the IProcess interface.

Use the Add(SPWeb, DateTime, Guid, Int32, Boolean, Guid, Guid, Int32) method to add the search and process operation to the SharePoint Server 2010 master timer job.

Constructors

SearchAndProcessItem() SearchAndProcessItem() SearchAndProcessItem()

Initializes a new instance of a SearchAndProcessItem object.

SearchAndProcessItem(String, String, String, String) SearchAndProcessItem(String, String, String, String) SearchAndProcessItem(String, String, String, String)

Initializes a new instance of a SearchAndProcessItem object.

Properties

AssemblyName AssemblyName AssemblyName

Gets or sets the name of the assembly that contains the class which implements the IProcess interface.

ClassName ClassName ClassName

Gets or sets the name of the class that implements the IProcess interface. This class is used to process each item returned by the search.

ContextualScopePath ContextualScopePath ContextualScopePath

Gets or sets the path to which the search is scoped.

(Inherited from SearchParameters)
ContextualScopeUrl ContextualScopeUrl ContextualScopeUrl

Gets or sets the site URL to which the search is scoped.

(Inherited from SearchParameters)
DisplayName DisplayName DisplayName

Gets or sets the name displayed on the e-mail report for this search and process job.

EnableQueryRules EnableQueryRules EnableQueryRules

Gets or sets a Boolean value that specifies whether the search query should process query rules.

(Inherited from SearchParameters)
EnableResultTableStacking EnableResultTableStacking EnableResultTableStacking

Gets or sets a Boolean value that specifies whether multiple result sets should be merged.

(Inherited from SearchParameters)
EnableStemming EnableStemming EnableStemming

Gets or sets a Boolean value that specifies whether stemming is enabled.

(Inherited from SearchParameters)
KeywordQuery KeywordQuery KeywordQuery

Gets and sets the query text that is used for executing the search.

(Inherited from SearchParameters)
LCID LCID LCID

Gets or sets the locale ID (LCID) of the culture that should be used to execute the search.

(Inherited from SearchParameters)
MethodArgs MethodArgs MethodArgs

Gets or sets any optional arguments to pass to the process assembly and class.

NoiseIgnored NoiseIgnored NoiseIgnored

Gets or sets a Boolean value that specifies whether the search query should execute even if the query text contains only noise words.

(Inherited from SearchParameters)
ResultsRequested ResultsRequested ResultsRequested

Gets or sets the number of search results requested for this query.

Scope Scope Scope

Gets and sets the scope for the search.

(Inherited from SearchParameters)
SearchApplication SearchApplication SearchApplication

Specifies the search application to use for the search operation.

TrimDuplicates TrimDuplicates TrimDuplicates

Gets or sets a Boolean value that specifies whether duplicate items should be removed from the search results.

(Inherited from SearchParameters)
UsersToNotify UsersToNotify UsersToNotify

Gets or sets a list of the e-mail addresses of the users to send a report to by e-mail on the search and process job results.

Methods

Add(SPWeb, DateTime, Guid, Int32, Boolean, Guid, Guid, Int32) Add(SPWeb, DateTime, Guid, Int32, Boolean, Guid, Guid, Int32) Add(SPWeb, DateTime, Guid, Int32, Boolean, Guid, Guid, Int32)

Adds the search and process job to the Microsoft Office SharePoint Server 2007 master timer job.

Deserialize(String) Deserialize(String) Deserialize(String)

Deserializes the SearchAndProcessItem object.

GetAssemblyName() GetAssemblyName() GetAssemblyName()

Gets the name of the assembly to call to process each item returned by the search.

RegisterSearchEngine(String, String, String, SPWebApplication) RegisterSearchEngine(String, String, String, SPWebApplication) RegisterSearchEngine(String, String, String, SPWebApplication)

Calls the RegisterSearchEngine within SearchAndProcessUtilities.

UnregisterSearchEngine(SPWebApplication) UnregisterSearchEngine(SPWebApplication) UnregisterSearchEngine(SPWebApplication)

Calls the UnregisterSearchEngine within SearchAndProcessUtilities.

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to