mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='https://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='https://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='https://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='https://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='https://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
MISSING BANNER

Solr_Documents_Searcher.Search Method



Perform an search for documents with matching parameters


Namespace: SobekCM.Engine_Library.Solr
Assembly: SobekCM_Engine_Library (in SobekCM_Engine_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public static bool Search(
	string AggregationCode,
	string QueryString,
	int ResultsPerPage,
	int Page_Number,
	ushort Sort,
	Custom_Tracer Tracer,
	out Search_Results_Statistics Complete_Result_Set_Info,
	out List<iSearch_Title_Result> Paged_Results
)

Parameters

AggregationCode
Type: System..::..String
Aggregation code within which to search
QueryString
Type: System..::..String
Quert string for the actual search to perform aggainst the Solr/Lucene engine
ResultsPerPage
Type: System..::..Int32
Number of results to display per a "page" of results
Page_Number
Type: System..::..Int32
Which page of results to return ( one-based, so the first page is page number of one )
Sort
Type: System..::..UInt16
Sort to apply before returning the results of the search
Tracer
Type: SobekCM.Tools..::..Custom_Tracer
Trace object keeps a list of each method executed and important milestones in rendering
Complete_Result_Set_Info
Type: SobekCM.Core.Results..::..Search_Results_Statistics%
[OUT] Information about the entire set of results
Paged_Results
Type: System.Collections.Generic..::..List<(Of <(<'iSearch_Title_Result>)>)>%
[OUT] List of search results for the requested page of results

Return Value

Type: Boolean
Page search result object with all relevant result information

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )