Class SearchRequest

Represents a facet used to search the repository

Inheritance
object
SearchRequest
Inherited Members
Namespace: Colectica.Repository.Api.Requests.V1
Assembly: Algenta.Colectica.Model.dll
Syntax
public class SearchRequest

Properties

Cultures

Gets the languages to be searched for any SearchTerms.

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

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>

LanguageSortOrder

Gets the language sort order for alphabetical sorting multilingual strings.

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

MaxResults

Gets or sets the maximum number of results to be returned.

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

NextResult

Gets or sets the next result offset of the first result to be returned. This is used for paging search results without using a ResultOffset for increased performance.

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

RankResults

Gets or sets a value indicating whether to rank search results by MetadataRank.

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

ResultOffset

Gets or sets the offset of the first result to be returned. This is used for paging search results.

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

ResultOrdering

Gets or sets the criteria used to order the search results.

Declaration
public SearchResultOrdering ResultOrdering { get; set; }
Property Value
Type Description
SearchResultOrdering

ReturnIdentifiersOnly

Gets or sets a value indicating only item identifiers should be returned, and other search response fields are left emtpy

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

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

SearchSetPredicate

Gets or sets the predicate that set search results must match. See RelationshipPredicates.

Declaration
public Guid SearchSetPredicate { get; set; }
Property Value
Type Description
Guid

SearchSets

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

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

SearchTargets

Gets the types of text fields that should be searched for any SearchTerms.

Declaration
public Collection<DdiStringType> SearchTargets { get; set; }
Property Value
Type Description
Collection<DdiStringType>

SearchTerms

Gets the textual search terms that results must match.

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

Tags

Gets the items that match an included tag.

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

UsePrefixSearch

Gets or sets a value indicating whether a prefix search should be used.

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

Operators

explicit operator SearchFacet(SearchRequest)

Cast DTO to model

Declaration
public static explicit operator SearchFacet(SearchRequest request)
Parameters
Type Name Description
SearchRequest request
Returns
Type Description
SearchFacet

Extension Methods