Web Components
  1. Injectables
  2. QueryQuestService

File

platform-components-ng/projects/platform-components-lib/src/lib/services/query-quest.service.ts

Description

Query Quest service

Index

Methods

Constructor

constructor(http: HttpClient, queryHelperService: QueryHelperService)
Parameters :
Name Type Optional
http HttpClient No
queryHelperService QueryHelperService No

Methods

Async exportQueryResults
exportQueryResults(queryId: number, queryName: string, queryInfo: literal type)

Export query results

Parameters :
Name Type Optional Description
queryId number No

Query Id
queryName string No

Query name
queryInfo literal type No

Query info

Returns : Promise<any>

Promise
getNextResultSet
getNextResultSet(nextLink: string)

Get next result set

Parameters :
Name Type Optional Description
nextLink string No

Next link
Returns : Promise<QueryResponse>

Promise
getPaginatedAdvancedSearch
getPaginatedAdvancedSearch(advanceSearchRequest: AdvanceSearchRequest, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated advance search

Parameters :
Name Type Optional Description
advanceSearchRequest AdvanceSearchRequest No

Advance search request
uiQueryDisplay UiQueryDisplay[] Yes

Ui Query Display (optional)
filterName string Yes

Filter name (optional)
uiQuerySortColumns UiQuerySortColumn[] Yes

Ui query sort columns (optional)
filterConditions QueryCondition[] Yes

Filter conditions (optional)
Returns : Promise<QueryResponse>

Promise
getPaginatedParameterizedQueryResult
getPaginatedParameterizedQueryResult(queryId: number, queryConditionValues: any, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated parameterized query result

Parameters :
Name Type Optional Description
queryId number No

Query Id
queryConditionValues any No

Query conditions values
uiQueryDisplay UiQueryDisplay[] Yes

Ui Query Display
filterName string Yes

Filter name
uiQuerySortColumns UiQuerySortColumn[] Yes

Ui query sort columns
filterConditions QueryCondition[] Yes
Returns : Promise<QueryResponse>

Promise
getPaginatedParameterizedQueryResultByQueryConditions
getPaginatedParameterizedQueryResultByQueryConditions(queryId: number, queryConditions: QueryCondition[], uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated parameterized query result by query conditions.

Parameters :
Name Type Optional Description
queryId number No
  • The ID of the query.
queryConditions QueryCondition[] No
  • The array of QueryCondition objects to use for the query.
uiQueryDisplay UiQueryDisplay[] Yes
  • (Optional) The columns to display in the UI.
filterName string Yes
  • (Optional) The name of the filter to apply.
uiQuerySortColumns UiQuerySortColumn[] Yes
  • (Optional) The columns to use for sorting.
filterConditions QueryCondition[] Yes
  • (Optional) Additional filter conditions to apply.
Returns : Promise<QueryResponse>

Promise - Resolves to the paginated query response.
Async getPaginatedQueryResult
getPaginatedQueryResult(queryId: number, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated query result by id

Parameters :
Name Type Optional Description
queryId number No

Query Id
uiQueryDisplay UiQueryDisplay[] Yes

Ui Query Display (optional)
filterName string Yes

Filter name (optional)
uiQuerySortColumns UiQuerySortColumn[] Yes

Ui query sort columns (optional)
filterConditions QueryCondition[] Yes

Filter conditions (optional)
Returns : Promise<QueryResponse>

Promise
getSearchInAllVersionsFlag
getSearchInAllVersionsFlag()

Get search in all versions flag

Returns : Observable<any>

Observable any
getSearchResults
getSearchResults(quickSearchRequest: QuickSearchRequest, filterName: string | null)

Get search result

Parameters :
Name Type Optional Description
quickSearchRequest QuickSearchRequest No
filterName string | null No

Filter name
Returns : Observable<QuickSearchResultItem[]>

Observable

result-matching ""

    No results matching ""