Engine_Database.Perform_Metadata_Exact_Search_Paged Method
Performs a metadata search for a piece of metadata that EXACTLY matches the provided search term and return one page of results
Namespace: SobekCM.Engine_Library.DatabaseAssembly: SobekCM_Engine_Library (in SobekCM_Engine_Library.dll) Version: 4.10.0.0 (4.10.0.0)
Syntax
| C# |
|---|
public static Multiple_Paged_Results_Args Perform_Metadata_Exact_Search_Paged(
string SearchTerm,
int FieldID,
bool IncludePrivateItems,
string AggregationCode,
long DateRangeStart,
long DateRangeEnd,
int ResultsPerPage,
int ResultsPage,
int Sort,
bool IncludeFacets,
List<short> FacetTypes,
bool ReturnSearchStatistics,
Custom_Tracer Tracer
) |
Parameters
- SearchTerm
- Type: System..::..String
Search condition string to be run against the databasse
- FieldID
- Type: System..::..Int32
Primary key for the field to search in the database
- IncludePrivateItems
- Type: System..::..Boolean
Flag indicates whether to include private items in the result set
- AggregationCode
- Type: System..::..String
Code for the aggregation of interest ( or empty string to search all aggregationPermissions )
- DateRangeStart
- Type: System..::..Int64
If this search includes a date range search, start of the date range, or -1
- DateRangeEnd
- Type: System..::..Int64
If this search includes a date range search, end of the date range, or -1
- ResultsPerPage
- Type: System..::..Int32
Number of results to return per "page" of results
- ResultsPage
- Type: System..::..Int32
Which page of results to return ( one-based, so the first page is page number of one )
- Sort
- Type: System..::..Int32
Current sort to use ( 0 = default by search or browse, 1 = title, 10 = date asc, 11 = date desc )
- IncludeFacets
- Type: System..::..Boolean
Flag indicates whether to include facets in the result set
- FacetTypes
- Type: System.Collections.Generic..::..List<(Of <(<'Int16>)>)>
Primary key for the metadata types to include as facets (up to eight)
- ReturnSearchStatistics
- Type: System..::..Boolean
Flag indicates whether to create and return statistics about the overall search results, generally set to TRUE for the first page requested and subsequently set to FALSE
- Tracer
- Type: SobekCM.Tools..::..Custom_Tracer
Trace object keeps a list of each method executed and important milestones in rendering
Return Value
Type:
Multiple_Paged_Results_Args Small arguments object which contains the page of results and optionally statistics about results for the entire search, including complete counts and facet information
Remarks
See Also
