Web Components
  1. Injectables
  2. QueryService

File

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

Description

Query service

Index

Methods

Constructor

constructor(http: HttpClient, dialogService: QppDialogService, queryHelperService: QueryHelperService, qppLocalisationService: QppLocalisationService, attributeService: AttributeService)
Parameters :
Name Type Optional
http HttpClient No
dialogService QppDialogService No
queryHelperService QueryHelperService No
qppLocalisationService QppLocalisationService No
attributeService AttributeService No

Methods

_openAssetExportDialog
_openAssetExportDialog(task$: any)

--------------------------------- private methods---------------------------------

Parameters :
Name Type Optional
task$ any No
Returns : void
convertToAdvanceSearchRequest
convertToAdvanceSearchRequest(queryConditionsArr: any, collectionIds?: Array, entity?: EntityType, recursive?: boolean, contentTypeIds?: number[], displayColumns?: UiQueryDisplay[], sortColumns?: UiQuerySortColumn[], includeAllVersions?: boolean)

Convert to advance search request

Parameters :
Name Type Optional Description
queryConditionsArr any No

Query condtion array
collectionIds Array<number> Yes

Collection Ids
entity EntityType Yes

Entity
recursive boolean Yes

Recursive
contentTypeIds number[] Yes

Content type Id list
displayColumns UiQueryDisplay[] Yes

Display columns
sortColumns UiQuerySortColumn[] Yes

Sort columns
includeAllVersions boolean Yes

include all versions info
Returns : AdvanceSearchRequest

AdvanceSearchRequest
createQppQueryObjects
createQppQueryObjects(queryStructureArr)

Transform the structured search conditions to server understandable query conitions ie transform the view object to server's query DTO.

Parameters :
Name Optional Description
queryStructureArr No

Query Structure list
Returns : any

any
Async createWatchQuerySession
createWatchQuerySession()

Create watch auery

Returns : any

Promise
deleteQuery
deleteQuery(queryId: number)

Delete query

Parameters :
Name Type Optional Description
queryId number No

Query Id
Returns : any

Observable
duplicateQuery
duplicateQuery(queryId: number, queryName: string)

Duplicate query

Parameters :
Name Type Optional Description
queryId number No

Query Id
queryName string No

Query name
Returns : any

Observable
executeParameterizedSearch
executeParameterizedSearch(queryId, queryParams, filterName?: string)

Execute parametrized search

Parameters :
Name Type Optional Description
queryId No

Query Id
queryParams No
filterName string Yes

Filter name
Returns : any

Observable
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
getAllQueries
getAllQueries()

Get all saved queries.

Returns : Promise<Observable<any>>

Promise<Observable>
getChildCollections
getChildCollections(advanceSearchRequest: AdvanceSearchRequest, collectionId: number, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterHiddenCollection?: boolean)

Get child collections

Parameters :
Name Type Optional Description
advanceSearchRequest AdvanceSearchRequest No

Advance search request
collectionId number No

Collection Id
uiQueryDisplay UiQueryDisplay[] Yes

Ui Query Display
filterName string Yes

Filter name
uiQuerySortColumns UiQuerySortColumn[] Yes

Ui query sort columns
filterHiddenCollection boolean Yes
Returns : Promise<QueryResponse>

Promise
getCollectionDisplay
getCollectionDisplay(collectionId: number)

Get collection display

Parameters :
Name Type Optional Description
collectionId number No

Collection id
Returns : Promise<any>

Promise
Async getCollectionForId
getCollectionForId(collectionId: number, uiQueryDisplay: any[])

Get collection for Id

Parameters :
Name Type Optional Description
collectionId number No

Collection Id
uiQueryDisplay any[] No

Ui Query Display
Returns : Promise<Entity>

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, queryId?: number, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated advance search

Parameters :
Name Type Optional Description
advanceSearchRequest AdvanceSearchRequest No

Advance search request
queryId number Yes

Query Id
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
getPaginatedAdvancedSearchWithoutNotification
getPaginatedAdvancedSearchWithoutNotification(advanceSearchRequest: AdvanceSearchRequest, queryId?: number, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated advanced search without notification

Parameters :
Name Type Optional Description
advanceSearchRequest AdvanceSearchRequest No

Advance search request
queryId number Yes

Query Id
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
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
getPaginatedParameterizedQueryResultWithoutNotification
getPaginatedParameterizedQueryResultWithoutNotification(queryId: number, queryConditionValues: any, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated parameterized query result without notification

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
Async getPaginatedQueryResult
getPaginatedQueryResult(queryId: number, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated query result

Parameters :
Name Type Optional Description
queryId number No

Query Id
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
Async getPaginatedQueryResultWithoutNotification
getPaginatedQueryResultWithoutNotification(queryId: number, uiQueryDisplay?: UiQueryDisplay[], filterName?: string, uiQuerySortColumns?: UiQuerySortColumn[], filterConditions?: QueryCondition[])

Get paginated query result without notification

Parameters :
Name Type Optional Description
queryId number No

Query Id
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
getQuery
getQuery(queryId: number)

Get query

Parameters :
Name Type Optional Description
queryId number No

Query Id
Returns : Observable<any>

Observable
getQueryResult
getQueryResult(queryId: number, filterName?: string, isAssetQuery?: boolean, uiQuerySortColumns?: UiQuerySortColumn[])

Get the assets which match the given query.

Parameters :
Name Type Optional Description
queryId number No

id of the query.
filterName string Yes
isAssetQuery boolean Yes
uiQuerySortColumns UiQuerySortColumn[] Yes
Returns : any

Observable
getQueryResultByGroup
getQueryResultByGroup(queryId: number, attributeId: number, queryConditions?: QueryGroupResultCondition[])

Get query result by group

Parameters :
Name Type Optional Description
queryId number No

Query Id
attributeId number No

Attribute Id
queryConditions QueryGroupResultCondition[] Yes

Query conditions
Returns : Observable<QueryGroupResult[]>

Observable<QueryGroupResult[]>
Async getQueryResultCount
getQueryResultCount(queryId: number)

Get query result count

Parameters :
Name Type Optional Description
queryId number No

Query Id
Returns : Promise<Number>

Promise
getQueryResultElement
getQueryResultElement(resultId: string, elementId: number)

Get query result element

Parameters :
Name Type Optional Description
resultId string No

Result Id
elementId number No

Element Id
Returns : Promise<Entity>

Promise
getQueryResultForConditions
getQueryResultForConditions(queryId: number, queryConditions: any[], filterName?: string)

Get the assets which match the given query.

Parameters :
Name Type Optional Description
queryId number No

id of the query
queryConditions any[] No

query conditions.
filterName string Yes

Filter name
Returns : any

Observable
getSearchAttributesPreference
getSearchAttributesPreference(preferenceId: number)

Get search attributes preference

Parameters :
Name Type Optional Description
preferenceId number No

Preference Id
Returns : Promise<any>

Promise
getSearchConditions
getSearchConditions(queryId: number)

Get conditions

Parameters :
Name Type Optional Description
queryId number No

Query Id
Returns : Observable<any>

Observable
Async keepWatchQuerySessionAlive
keepWatchQuerySessionAlive()

Keep watch query session alive

Returns : any

Promie
parameterizedQueryParams
parameterizedQueryParams(queryId: number)

Get the definition of the query.

Parameters :
Name Type Optional Description
queryId number No

id of the query.
Returns : any

Observable
processAdvancedSearch
processAdvancedSearch(queryConditionsArr: any, filterName?: string, collectionIds?: Array, entity?: "collections" | "assets", recursive?: boolean, contentTypeIds?: number[])

Process advance search

Parameters :
Name Type Optional Description
queryConditionsArr any No

Query condtion array
filterName string Yes

Filter name
collectionIds Array<number> Yes

Collection Ids
entity "collections" | "assets" Yes

Entity
recursive boolean Yes

Recursive
contentTypeIds number[] Yes

Content type Id list
Returns : any

Promise
queryDefinition
queryDefinition(queryId)

Query definition

Parameters :
Name Optional Description
queryId No

Query Id
Returns : any

Observable
saveCollectionDisplay
saveCollectionDisplay(collectionId: number, uiQueryDisplay: UiQueryDisplay[], uiQuerySortColumns: UiQuerySortColumn[], applyToAll: boolean)

Save collection

Parameters :
Name Type Optional Description
collectionId number No

Collection Id
uiQueryDisplay UiQueryDisplay[] No

Ui Query Display
uiQuerySortColumns UiQuerySortColumn[] No

Ui query sort columns
applyToAll boolean No

Apply to all
Returns : any

Promise
saveDisplayMode
saveDisplayMode(displayMode: number, queryId?: number, collectionId?: number)

Save display mode

Parameters :
Name Type Optional Description
displayMode number No

Display mode
queryId number Yes

Query Id
collectionId number Yes

Collection Id
Returns : Promise<any>

Promise
saveQuery
saveQuery(queryName: string, queryConditionsArr: any, collectionIds?: Array, entity?: "collections" | "assets", recursive?: boolean, contentTypeIds?: number[], displaycolumns?: UiQueryDisplay[], sortColumns?: UiQuerySortColumn[], displayMode?: string, includeAllVersions?: boolean)

Save query

Parameters :
Name Type Optional
queryName string No
queryConditionsArr any No
collectionIds Array<number> Yes
entity "collections" | "assets" Yes
recursive boolean Yes
contentTypeIds number[] Yes
displaycolumns UiQueryDisplay[] Yes
sortColumns UiQuerySortColumn[] Yes
displayMode string Yes
includeAllVersions boolean Yes
Returns : Observable<number>

Observable
saveQueryDisplay
saveQueryDisplay(queryId: number, uiQueryDisplay: UiQueryDisplay[], uiQuerySortColumns?: UiQuerySortColumn[])

Save query display

Parameters :
Name Type Optional Description
queryId number No

Query Id
uiQueryDisplay UiQueryDisplay[] No

Ui Query Display
uiQuerySortColumns UiQuerySortColumn[] Yes

Ui query sort columns
Returns : any

Promise
setSearchAttributesPreference
setSearchAttributesPreference(preferenceId: number, preferenceValues: any)

Set search attributes preference

Parameters :
Name Type Optional Description
preferenceId number No

Preference Id
preferenceValues any No

Preference values
Returns : Promise<any>

Promise
sharedQueryTrustees
sharedQueryTrustees(queryId: number)

Shared query trustees

Parameters :
Name Type Optional Description
queryId number No

Query Id
Returns : any

Observable
shareWithTrustees
shareWithTrustees(queryId: number, trusteeIds: Array)

Share with trustees

Parameters :
Name Type Optional Description
queryId number No

Query Id
trusteeIds Array<number> No

Trustee Id list
Returns : any

Observable
Async transformToSearchCondition
transformToSearchCondition(qppQueryCondition)

Transform to serch condition

Parameters :
Name Optional Description
qppQueryCondition No

Qpp query condition
Returns : Promise<any>

Promise
unShareWithTrustees
unShareWithTrustees(queryId: number, trusteeIds: Array)

Unshare with trustee

Parameters :
Name Type Optional Description
queryId number No

Query Id
trusteeIds Array<number> No

Trustee Id list
Returns : any

Observable
updateQuery
updateQuery(queryId: number, queryName: string, queryConditionsArr: any, collectionIds?: Array, entity?: "collections" | "assets", recursive?: boolean, contentTypeIds?: number[], displaycolumns?: UiQueryDisplay[], sortColumns?: UiQuerySortColumn[], displayMode?: string, includeAllVersions?: boolean)

Update query

Parameters :
Name Type Optional Description
queryId number No

Query Id
queryName string No

Query name
queryConditionsArr any No

Query condtion array
collectionIds Array<number> Yes

Collection Ids
entity "collections" | "assets" Yes

Entity
recursive boolean Yes

Recursive
contentTypeIds number[] Yes

Content type Id list
displaycolumns UiQueryDisplay[] Yes
sortColumns UiQuerySortColumn[] Yes

Sort columns
displayMode string Yes

Display mode
includeAllVersions boolean Yes

includeAllVersions
Returns : any

Promise

result-matching ""

    No results matching ""