Efficy Enterprise API

Class: ConsultObject

ConsultObject

Class returned by openConsultObject

new ConsultObject(remoteAPI, entity, key [, consultHandle])

Opens an consult context for the record identified by entity and key. A context remains memory-resident (on the web server) until it is closed. Always match with a closeContext() call to avoid memory consumption.
Parameters:
Name Type Argument Description
remoteAPI RemoteAPI
entity string The entity name of the consulted record, e.g. "Comp"
key number The key of the consulted record
consultHandle number <optional>
 Possibility to pass an existing consultHandle
Properties:
Name Type Description
entity string The entity name of the consulted record
key number The key of the consulted record
consulthandle number The handle of the consult operation
data object The master, categories and detail objects available as properties of data
Source:

Extends

  • RemoteObject

Members

<protected> closecontext

Source:

Methods

<protected> afterExecute()

Source:

<protected> asJsonRpc()

Source:

closeContext()

Closes the context and frees the memory on the web server.
Source:

getCategoryDataSet(categoryName)

Retrieves the DataSet for category categoryName. Can be null when the category is not available to the current user.
Parameters:
Name Type Description
categoryName string name of the category, e.g. "DOCU$INVOICING"
Source:
Returns:
Type
DataSetObject

getDetailDataSet(detail [, filter] [, includeBlobContent])

Retrieves a relation DataSet for the specified detail in the edit context.
Parameters:
Name Type Argument Default Description
detail string The detail name, e.g. "Comp"
filter string <optional>
 "" SQL filter expression, e.g. "COMMENT like '%template%'"
includeBlobContent boolean <optional>
 false If true, blob fields (e.g. memo, stream) are returned
Source:
Returns:
Type
DataSetObject

getMasterDataSet()

Retrieves a master DatasetObject from the consult context.
Source:
Returns:
Type
DataSetObject