Class QueryObject

Hierarchy (view full)

RemoteDataSet
- QueryObject

Index

Constructors

Properties

dataSetName? detail? ds id key? loadBlobs master? queryParams recordCount requestObject responseObject

Accessors

Methods

afterExecute asJsonRpc findAttachment findDataSetArray findFunc findFunc2 findFuncArray findFuncArray2 findListArray registerObject

Constructors

constructor

new QueryObject(remoteAPI, key?, master?, detail?, queryParams?, loadBlobs?, recordCount?): QueryObject
Parameters
- remoteAPI: JsonRpcApi
- Optional key: string
- Optional master: number
- Optional detail: number
- queryParams: string[] = []
- loadBlobs: boolean = false
- recordCount: number = 0
Returns QueryObject
Overrides RemoteDataSet.constructor
- Defined in src/crm-rpc/rpc-objects/query.ts:35

Properties

`Protected` `Optional` dataSetName

dataSetName?: string

`Private` `Optional` detail

detail?: number

`Protected` ds

ds: null | DataSetInternal = null

`Protected` id

id: string

`Private` `Optional` key

key?: string

`Private` loadBlobs

loadBlobs: boolean = false

`Private` `Optional` master

master?: number

`Private` queryParams

queryParams: string[] = []

`Private` recordCount

recordCount: number = 0

`Protected` requestObject

requestObject: null | RpcNamedOperation

`Protected` responseObject

responseObject: {}

Type declaration

Accessors

`Protected` api

get api(): JsonRpcApi
Returns JsonRpcApi
Inherited from RemoteDataSet.api
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:21

item

get item(): null | JSONPrimitiveRecord
When exists, the first item of the items, else null

Returns null | JSONPrimitiveRecord
Inherited from RemoteDataSet.item
- Defined in src/crm-rpc/rpc-objects/dataset.ts:120

items

get items(): JSONPrimitiveRecord[]
The to array converted dataset

Returns JSONPrimitiveRecord[]
Inherited from RemoteDataSet.items
- Defined in src/crm-rpc/rpc-objects/dataset.ts:113

Methods

`Protected` afterExecute

afterExecute(): void
Returns void
Inherited from RemoteDataSet.afterExecute
- Defined in src/crm-rpc/rpc-objects/dataset.ts:103

`Protected` asJsonRpc

asJsonRpc(): RpcNamedOperation
Returns RpcNamedOperation
Overrides RemoteDataSet.asJsonRpc
- Defined in src/crm-rpc/rpc-objects/query.ts:39

`Protected` findAttachment

findAttachment(resp, key): undefined | JSONPrimitiveRecord
Parameters
- resp: JSONPrimitiveRecord
- key: string
Returns undefined | JSONPrimitiveRecord
Inherited from RemoteDataSet.findAttachment
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:56

`Protected` findDataSetArray

findDataSetArray(resp, dataSetName?): JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- dataSetName: string = "dataset"
Returns JSONPrimitiveRecord[]
Inherited from RemoteDataSet.findDataSetArray
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:37

`Protected` findFunc

findFunc(resp, name): any
Parameters
- resp: JSONPrimitiveRecord
- name: string
Returns any
Inherited from RemoteDataSet.findFunc
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:61

`Protected` findFunc2

findFunc2(resp, name, name2, value2): any
Parameters
- resp: JSONPrimitiveRecord
- name: string
- name2: string
- value2: string | number
Returns any
Inherited from RemoteDataSet.findFunc2
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:66

`Protected` findFuncArray

findFuncArray(resp, name): null | JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- name: string
Returns null | JSONPrimitiveRecord[]
Inherited from RemoteDataSet.findFuncArray
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:71

`Protected` findFuncArray2

findFuncArray2(resp, name, name2, value2): null | JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- name: string
- name2: string
- value2: string | number
Returns null | JSONPrimitiveRecord[]
Inherited from RemoteDataSet.findFuncArray2
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:76

`Protected` findListArray

findListArray(resp, listName?): JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- listName: string = "stringlist"
Returns JSONPrimitiveRecord[]
Inherited from RemoteDataSet.findListArray
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:52

`Protected` registerObject

registerObject(object): void
Parameters
- object: RpcObject
Returns void
Inherited from RemoteDataSet.registerObject
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:33