Show / Hide Table of Contents

Class AdvancedSearchRequest

Represents a facet used to search the repository

Inheritance
object
AdvancedSearchRequest
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Colectica.Repository.Api.Requests.V1
Assembly: Algenta.Colectica.Model.dll
Syntax
public class AdvancedSearchRequest

Properties

BooleanFacets

List of boolean facets to search

Declaration
public List<BooleanPropertyFacet> BooleanFacets { get; set; }
Property Value
Type Description
List<BooleanPropertyFacet>

CodeValueFacets

List of code value facets to search

Declaration
public List<CodeValuePropertyFacet> CodeValueFacets { get; set; }
Property Value
Type Description
List<CodeValuePropertyFacet>

DateFacets

List of date facets to search

Declaration
public List<DatePropertyFacet> DateFacets { get; set; }
Property Value
Type Description
List<DatePropertyFacet>

DecimalFacets

List of numeric facets to search

Declaration
public List<DecimalPropertyFacet> DecimalFacets { get; set; }
Property Value
Type Description
List<DecimalPropertyFacet>

ItemTypes

Gets the types of items that should be returned from a search.

Declaration
public Collection<Guid> ItemTypes { get; set; }
Property Value
Type Description
Collection<Guid>

LocatorFacets

List of unique id facets to search

Declaration
public List<LocatorPropertyFacet> LocatorFacets { get; set; }
Property Value
Type Description
List<LocatorPropertyFacet>

MaxResults

Gets or sets the maximum number of results to be returned. This is used to create a page size when paging results.

Declaration
public int? MaxResults { get; set; }
Property Value
Type Description
int?

NextResult

Gets or sets the numeric id of the next result to be returned for a repeated\paged query. This is used for paging search results without using a batch size based offset for increased performance.

Declaration
public long? NextResult { get; set; }
Property Value
Type Description
long?

ResultsIncludeAll

Gets or sets a value indicating that all properties and tags should be included in the results

Declaration
public bool ResultsIncludeAll { get; set; }
Property Value
Type Description
bool

ResultsIncludeDescribable

Gets or sets a value indicating that name, label, and description properties should be included in the results

Declaration
public bool ResultsIncludeDescribable { get; set; }
Property Value
Type Description
bool

ResultsIncludeItemTags

Gets or sets a value indicating that item tags should be included in the results

Declaration
public bool ResultsIncludeItemTags { get; set; }
Property Value
Type Description
bool

SearchChildSets

Perform the search within the child sets identified by the root items in the search set.

Declaration
public Collection<IdentifierInRequest> SearchChildSets { get; set; }
Property Value
Type Description
Collection<IdentifierInRequest>

SearchDepricatedItems

Gets or sets a value indicating whether deprecated items should be included in search results.

Declaration
public bool SearchDepricatedItems { get; set; }
Property Value
Type Description
bool

SearchLatestVersion

Gets or sets a value indicating whether to only include the latest versions of items in the search results.

Declaration
public bool SearchLatestVersion { get; set; }
Property Value
Type Description
bool

SearchParentSets

Perform the search within the reverse sets identified by the root items in the search set.

Declaration
public Collection<IdentifierInRequest> SearchParentSets { get; set; }
Property Value
Type Description
Collection<IdentifierInRequest>

Tags

Gets the items that match an included tag.

Declaration
public Collection<string> Tags { get; set; }
Property Value
Type Description
Collection<string>

TextFacets

List of text facets to search

Declaration
public List<TextPropertyFacet> TextFacets { get; set; }
Property Value
Type Description
List<TextPropertyFacet>

Extension Methods

Extensions.Yield<T>(T)
In this article
Back to top Generated by DocFX