Class ConsultObject

Class returned by openConsultObject

Hierarchy

  • RpcObject
    • ConsultObject

Constructors

constructor

Properties

dataSetList entity id isDirty key requestObject responseObject

Accessors

api

Methods

afterExecute asJsonRpc findAttachment findDataSetArray findFunc findFunc2 findFuncArray findFuncArray2 findListArray getCategoryDataSet getDetailDataSet getMasterDataSet registerObject resetState setDirty

Constructors

constructor

  • new ConsultObject(remoteAPI, entity, key): ConsultObject

  • Opens an consult context for the record identified by entity and key.

    Parameters

    • remoteAPI: JsonRpcApi
    • entity: string

      The entity name of the consulted record, e.g. "Comp"

    • key: string

      The key of the consulted record

    Returns ConsultObject

Properties

Private dataSetList

dataSetList: DataSetList

entity

entity: string

The entity name of the consulted record, e.g. "Comp"

Protected id

id: string

Private isDirty

isDirty: boolean = false

key

key: string

The key of the consulted record

Protected requestObject

requestObject: null | RpcNamedOperation

Protected responseObject

responseObject: {}

Type declaration

    Accessors

    Protected api

    Methods

    Protected afterExecute

    Protected asJsonRpc

    Protected findAttachment

    Protected findDataSetArray

    Protected findFunc

    Protected findFunc2

    Protected findFuncArray

    Protected findFuncArray2

    Protected findListArray

    getCategoryDataSet

    • getCategoryDataSet(categoryName): DataSet

    • Retrieves the DataSet for category categoryName. Can be null when the category is not available to the current user.

      Parameters

      • categoryName: string

        name of the category, e.g. "DOCU$INVOICING"

      Returns DataSet

    getDetailDataSet

    • getDetailDataSet(detail, filter?, includeBlobContent?): DataSet

    • Retrieves a relation DataSet for the specified detail in the edit context.

      Parameters

      • detail: string

        The detail name, e.g. "Comp"

      • filter: string = ""

        SQL filter expression, e.g. "COMMENT like '%template%'"

      • includeBlobContent: boolean = false

        If true, blob fields (e.g. memo, stream) are returned

      Returns DataSet

    getMasterDataSet

    Protected registerObject

    Private resetState

    Private setDirty

    Settings

    Member Visibility

    Theme

    On This Page

    constructordataSetListentityidisDirtykeyrequestObjectresponseObjectapiafterExecuteasJsonRpcfindAttachmentfindDataSetArrayfindFuncfindFunc2findFuncArrayfindFuncArray2findListArraygetCategoryDataSetgetDetailDataSetgetMasterDataSetregisterObjectresetStatesetDirty