<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Dynamicweb.QueryPublisher</name>
    </assembly>
    <members>
        <member name="T:Dynamicweb.QueryPublisher.CreationParameters">
            <summary>
            Represents a container for all objects and primitive parameters required to build
            or render a Query Publisher view (templates, lists, facets, paging, sorting, etc).
            </summary>
            <param name="parameters">
            Arbitrary contextual values (typically coming from request, paragraph settings, or custom logic)
            exposed to templates / rendering logic. Never null (internally normalized to an empty dictionary).
            </param>
            <param name="facets">
            Raw facet group result map keyed by facet group system name. Never null (internally normalized
            to an empty dictionary).
            </param>
            <remarks>
            This type is a simple immutable+mutable hybrid aggregate:
             - The dictionaries passed into the primary constructor are captured once (read-only fields).
             - Other members are mutable so the pipeline can enrich the instance progressively.
            All collections default to empty to minimize null checks in consumers.
            </remarks>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.CreationParameters.#ctor(System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.Dictionary{System.String,Dynamicweb.Indexing.Querying.Faceting.FacetGroupResult})">
            <summary>
            Represents a container for all objects and primitive parameters required to build
            or render a Query Publisher view (templates, lists, facets, paging, sorting, etc).
            </summary>
            <param name="parameters">
            Arbitrary contextual values (typically coming from request, paragraph settings, or custom logic)
            exposed to templates / rendering logic. Never null (internally normalized to an empty dictionary).
            </param>
            <param name="facets">
            Raw facet group result map keyed by facet group system name. Never null (internally normalized
            to an empty dictionary).
            </param>
            <remarks>
            This type is a simple immutable+mutable hybrid aggregate:
             - The dictionaries passed into the primary constructor are captured once (read-only fields).
             - Other members are mutable so the pipeline can enrich the instance progressively.
            All collections default to empty to minimize null checks in consumers.
            </remarks>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.PagingHandler">
            <summary>
            Gets or sets the paging handler controlling paging activation, current page and ranges.
            Must be provided by the caller before paging is evaluated in the pipeline.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.QueryResult">
            <summary>
            Gets or sets the concrete query execution result (documents and facet groups)
            produced by the indexing/query subsystem.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.FacetGroups">
            <summary>
            Gets or sets the facet group definitions (configuration) used to build UI
            prior to or after binding facet counts (<see cref="P:Dynamicweb.QueryPublisher.CreationParameters.Facets" />).
            Defaults to an empty sequence.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.SortOrder">
            <summary>
            Gets or sets the effective sort order applied to the query (may be user selected).
            Defaults to an empty sequence.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.Parameters">
            <summary>
            Gets the arbitrary parameter bag made available to templates or
            downstream processing components. Never null.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.Facets">
            <summary>
            Gets the executed facet group results keyed by facet group name. Never null.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.Query">
            <summary>
            Gets or sets the query definition that produced <see cref="P:Dynamicweb.QueryPublisher.CreationParameters.QueryResult"/>
            Must be supplied so that consumers can inspect parameters, meta or sorting.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.CreationParameters.ShowFacetOptionsWithNoResults">
            <summary>
            Gets or sets a value indicating whether facet options with zero result count
            should still be rendered (useful for keeping UI stable / visibility of all filters).
            </summary>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.FacetGroupViewModel">
            <summary>
            Represents a <see cref="T:Dynamicweb.Rendering.ViewModelBase"/> for facet group information.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetGroupViewModel.Name">
            <summary>
            The name of the facet group, for example "Electricals".
            </summary>
            <value>The display name of the facet group.</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetGroupViewModel.Description">
            <summary>
            A description of the facet group.
            </summary>
            <value>Detailed information about the facet group.</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetGroupViewModel.Facets">
            <summary>
            A list of facets that are members of the facet group.
            </summary>
            <value>Collection of facets.</value>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.FacetOptionViewModel">
            <summary>
            Represents a <see cref="T:Dynamicweb.Rendering.ViewModelBase"/> for facet option information.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetOptionViewModel.Name">
            <summary>
            Name of the facet option, for example "center" or "front", presented to users as a filter option.
            This name helps users filter their search.
            </summary>
            <value>The display name of the facet option.</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetOptionViewModel.Label">
            <summary>
            Label of the facet option.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetOptionViewModel.Value">
            <summary>
            Value of the facet option.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetOptionViewModel.Sort">
            <summary>
            Sort value for this option in the facet results.
            </summary>
            <value>A number indicating its sort order. 0 if not specified</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetOptionViewModel.Selected">
            <summary>
            Whether the facet option is selected.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetOptionViewModel.Count">
            <summary>
            Total count of results for this option.
            </summary>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.FacetViewModel">
            <summary>
            Represents a <see cref="T:Dynamicweb.Rendering.ViewModelBase"/> for facet information.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.Name">
            <summary>
            The name of the facet, for example "Engine Type", presented to users as a search category.
            This name helps users identify different search/filter categories.
            </summary>
            <value>The display name of the facet.</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.QueryParameter">
            <summary>
            The query parameter associated with the facet, for example "ElectricalType".
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.QueryParameterType">
            <summary>
            The type of the query parameter.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.QueryParameterDefaultValue">
            <summary>
            Default value of the query parameter, if none is set.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.RenderType">
            <summary>
            How the facet will be rendered to the user, for example "Checkboxes" or "Colors".
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.Field">
            <summary>
            Field to retrieve facet options from.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.Type">
            <summary>
            Type of facet, for example "Field", "List", or "Term".
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.Value">
            <summary>
            Value of the facet.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.FacetOptions">
            <summary>
            Collection of facet options.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.OptionCount">
            <summary>
            Number of facet options
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.MinimumValue">
            <summary>
            Minimum value of the facet.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.MaximumValue">
            <summary>
            Maximum value of the facet.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.OptionWithResultCount">
            <summary>
            Number of facet options that have a result associated
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.FacetViewModel.OptionResultTotalCount">
            <summary>
            Total count of results across all options
            </summary>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.Frontend">
            <summary>
            Represents a frontend of the QueryPublisher module.
            </summary>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.Frontend.GetModuleContent">
            <summary>
            Gets the content of QueryPublisher module.
            </summary>
            <returns>String representation of context</returns>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.Notifications.Querying">
            <summary>
            Class Querying. This class cannot be inherited.
            </summary>
        </member>
        <member name="F:Dynamicweb.QueryPublisher.Notifications.Querying.BeforeQuery">
            <summary>
            The before query
            </summary>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.Notifications.Querying.BeforeQueryArgs">
            <summary>
            Class BeforeQueryArgs.
            </summary>
            <seealso cref="T:Dynamicweb.Extensibility.Notifications.NotificationArgs" />
        </member>
        <member name="P:Dynamicweb.QueryPublisher.Notifications.Querying.BeforeQueryArgs.Query">
            <summary>
            Gets or sets the query.
            </summary>
            <value>The query.</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.Notifications.Querying.BeforeQueryArgs.Settings">
            <summary>
            Gets or sets the settings.
            </summary>
            <value>The settings.</value>
        </member>
        <member name="F:Dynamicweb.QueryPublisher.Notifications.Querying.AfterQuery">
            <summary>
            The after query
            </summary>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.Notifications.Querying.AfterQueryArgs">
            <summary>
            Class AfterQueryArgs.
            </summary>
            <seealso cref="T:Dynamicweb.Extensibility.Notifications.NotificationArgs" />
        </member>
        <member name="P:Dynamicweb.QueryPublisher.Notifications.Querying.AfterQueryArgs.Query">
            <summary>
            Gets or sets the query.
            </summary>
            <value>The query.</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.Notifications.Querying.AfterQueryArgs.Settings">
            <summary>
            Gets or sets the settings.
            </summary>
            <value>The settings.</value>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.Notifications.Querying.AfterQueryArgs.Result">
            <summary>
            Gets or sets the result.
            </summary>
            <value>The result.</value>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.QueryParameterViewModel">
            <summary>
            Represents a <see cref="T:Dynamicweb.Rendering.ViewModelBase"/> for query parameter information.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryParameterViewModel.Name">
            <summary>
            Name of the query parameter.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryParameterViewModel.DefaultValue">
            <summary>
            Default value if none is set.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryParameterViewModel.Value">
            <summary>
            The value given by the user.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryParameterViewModel.IsHandledAsFacet">
            <summary>
            Indicates whether the query parameter is being handled as a facet.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryParameterViewModel.TypeName">
            <summary>
            Type of the query parameter.
            </summary>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherQueryHelper.HandleFacetsFromQueryString(System.Collections.Generic.IList{Dynamicweb.Indexing.Querying.Faceting.IFacetGroup},Dynamicweb.Indexing.Querying.IQuery,Dynamicweb.Indexing.Querying.IQueryResult,System.Collections.Generic.Dictionary{System.String,System.Object})">
            <summary>
            Handles the 
            </summary>
            <param name="query"></param>
            <param name="facetGroups"></param>
            <param name="queryResult"></param>
            <param name="parameters"></param>
            <returns></returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherQueryHelper.ObtainParametersFromRequest(System.Collections.Generic.IEnumerable{Dynamicweb.Indexing.Querying.QueryParameter},System.Boolean)">
            <summary>
            Obtains parameters from the request based on the provided query parameters.
            </summary>
            <param name="queryParameters">The collection of query parameters to obtain values for.</param>
            <param name="isDefault">Indicates whether to use default values if the request does not contain the parameters.</param>
            <returns>A dictionary containing the parameter names and their corresponding values.</returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherQueryHelper.HandleFacetGroupResult(Dynamicweb.Indexing.Querying.IQuery,Dynamicweb.Indexing.Querying.Faceting.IFacetGroup,Dynamicweb.Indexing.Querying.Faceting.FacetGroupResult,System.Collections.Generic.Dictionary{System.String,System.Object})">
            <summary>
            Reads the values from the querystring and set if a specific facet option is selected or not
            </summary>
            <param name="query"></param>
            <param name="facetGroup"></param>
            <param name="facetGroupResult"></param>
            <param name="parameters"></param>
            <returns></returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherQueryHelper.Contains(System.Array,System.Object)">
            <summary>
            Determines whether [contains] [the specified inputArray].
            </summary>
            <param name="input">The inputArray.</param>
            <param name="item">The obj.</param>
            <returns></returns>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.QueryPublisherViewModelFactory">
            <summary>
            Handles creation of QueryPublisher view models.
            </summary>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherViewModelFactory.CreateQueryResultViewModel(Dynamicweb.QueryPublisher.CreationParameters)">
            <summary>
            Creates a viewmodel of a query result.
            </summary>
            <param name="parameters">Parameters used to create the view model</param>
            <returns>QueryResultViewModel</returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherViewModelFactory.GetQueryResult(Dynamicweb.Indexing.Querying.IQueryResult)">
            <summary>
            Creates list of query results.
            </summary>
            <param name="queryResult">Collection of query results</param>
            <returns>The collection of results.</returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherViewModelFactory.GetFacetGroups(System.Collections.Generic.IEnumerable{Dynamicweb.Indexing.Querying.Faceting.IFacetGroup},System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.Dictionary{System.String,Dynamicweb.Indexing.Querying.Faceting.FacetGroupResult},Dynamicweb.Indexing.Querying.IQuery,System.Boolean)">
            <summary>
            Creates a list of view models of facet groups.
            </summary>
            <param name="facetGroups">Facet groups</param>
            <param name="parameters">Facet parameters</param>
            <param name="facetGroupResults">Facet group query results.</param>
            <param name="query">Basic query model</param>
            <param name="showFacetOptionsWithNoResults">Show facet options with no result</param>
            <returns>The collection of <see cref="T:Dynamicweb.QueryPublisher.FacetGroupViewModel"/></returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherViewModelFactory.GetFacets(Dynamicweb.Indexing.Querying.Faceting.IFacetGroup,System.Collections.Generic.Dictionary{System.String,System.Object},Dynamicweb.Indexing.Querying.Faceting.FacetGroupResult,Dynamicweb.Indexing.Querying.IQuery,System.Boolean)">
            <summary>
            Creates a collection of view models of facets.
            </summary>
            <param name="facetGroup">Facet group</param>
            <param name="facetParameters">Facet parameters</param>
            <param name="facetGroupResult">Facet group query result</param>
            <param name="query">Basic query model</param>
            <param name="showFacetOptionsWithNoResults">Show facet options with no result</param>
            <returns>The collection of <see cref="T:Dynamicweb.QueryPublisher.FacetViewModel"/></returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherViewModelFactory.GetQueryParameters(Dynamicweb.Indexing.Querying.IQuery,System.Collections.Generic.IEnumerable{Dynamicweb.Indexing.Querying.Faceting.IFacetGroup},System.Collections.Generic.Dictionary{System.String,System.Object})">
            <summary>
            Creates a list of view models of query parameters.
            </summary>
            <param name="query">Basic query model</param>
            <param name="facetGroups">Facet groups</param>
            <param name="facetParameters">Facet parameters</param>
            <returns>The collection of <see cref="T:Dynamicweb.QueryPublisher.QueryParameterViewModel"/></returns>
        </member>
        <member name="M:Dynamicweb.QueryPublisher.QueryPublisherViewModelFactory.GetOptionValue(System.Object)">
            <summary>
            Gets the values from the facet option.
            </summary>
            <param name="value">Facet option value</param>
            <returns>string</returns>
        </member>
        <member name="T:Dynamicweb.QueryPublisher.QueryResultViewModel">
            <summary>
            Represents a <see cref="T:Dynamicweb.Rendering.ViewModelBase"/> for query result information.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.PageSize">
            <summary>
            Items count per page.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.PageCount">
            <summary>
            Count of pages.
            If this value is greater than 0, the view model result will be paginated, otherwise, plain list.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.CurrentPage">
            <summary>
            Current page number.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.TotalCount">
            <summary>
            Total number of query results in the list.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.SortBy">
            <summary>
            Gets or sets the field that the list is sorted by. If the result is sorted by multiple fields, only the first is here.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.SortOrder">
            <summary>
            Gets or sets the sort order that the list is sorted by. If the result is sorted by multiple fields, only the first is here.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.SpellCheckerSuggestions">
            <summary>
            Collection of suggestions from a spell checker.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.Results">
            <summary>
            Collection of results.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.FacetGroups">
            <summary>
            Collection of facet group view models.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.QueryResultViewModel.Parameters">
            <summary>
            Collection of query parameters.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.QueryName">
            <summary>
            Used together with the <see cref="P:Dynamicweb.QueryPublisher.SearchRequest.RepositoryName"/> to perform a search for results.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.RepositoryName">
            <summary>
            Used together with the <see cref="P:Dynamicweb.QueryPublisher.SearchRequest.QueryName"/> to perform a search for results.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.Parameters">
            <summary>
            Search parameters associated with the query.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.ShowFacetOptionsWithNoResult">
            <summary>
            Determines whether facet options without results are displayed.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.SortBy">
            <summary>
            The field to sort by.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.PageSize">
            <summary>
            Limits the number of results in the returned view
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.CurrentPage">
            <summary>
            Defines which page of the paginated resultset to return. Eg. PageSize of 10 and CurrentPage of 2 in a resultset of 30, returns result item #11 to #20.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.FacetGroupNames">
            <summary>
            List FacetGroupNames.
            </summary>
        </member>
        <member name="P:Dynamicweb.QueryPublisher.SearchRequest.SortOrder">
            <summary>
            The sort direction. Default is ASC, the other option is DESC.
            </summary>
        </member>
    </members>
</doc>
