API query SelectStoredSearch (optimised)

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i	=
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tRole.RoleName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tStoredSearch.StoredSearchAutoApply	l	=,<>
tStoredSearch.StoredSearchLookupRef	c	=,>=,>,<>,<=,<,begins,can-do,matches
tStoredSearch.StoredSearchName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tStoredSearch.StoredSearchRowsToRetrieve	i	=,>=,>,<>,<=,<
tStoredSearch.StoredSearchSortColumn	c	=,>=,>,<>,<=,<,begins,can-do,matches
tUsr.UsrLogin	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each StoredSearch where

StoredSearch.Company_Id = iiCompanyId AND
(StoredSearch.Company_ID = iiCompanyId OR
StoredSearch.Company_ID = 0 )

first Company (outer-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = StoredSearch.Company_ID AND

first Role (outer-join) where

Role.Role_ID = StoredSearch.Role_ID AND

first Usr (outer-join) where

Usr.Usr_ID = StoredSearch.Usr_ID AND

query resultset tqSelectStoredSearch

field name	data type	db field	description
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcComponentName	character	calculated
tiRole_ID	integer	StoredSearch.Role_ID	Role
tcRoleName	character	Role.RoleName	Role Name
tiStoredSearch_ID	integer	StoredSearch.StoredSearch_ID	Record ID
tlStoredSearchAutoApply	logical	StoredSearch.StoredSearchAutoApply	When true, default filter values will be applied automatically. When false, the browse grid is empty when opening the window.
tiStoredSearchClassVersion	integer	StoredSearch.StoredSearchClassVersion	When this version is different from the current version of the business component on which the browse is based, filter fields and resultset fields in the stored search will be updated to current version (new fields added, old fields removed).
tcStoredSearchLevel	character	calculated
tcStoredSearchLookupRef	character	StoredSearch.StoredSearchLookupRef	reference to the browse window
tcStoredSearchName	character	StoredSearch.StoredSearchName	reference to the stored search
tiStoredSearchRowsToRetrieve	integer	StoredSearch.StoredSearchRowsToRetrieve	maximum number of rows in the browse grid
tcStoredSearchSortColumn	character	StoredSearch.StoredSearchSortColumn	business field name of a column in the result set to sort on
tiUsr_ID	integer	StoredSearch.Usr_ID	User
tcUsrLogin	character	Usr.UsrLogin	Login
StoredSearchCustom	character	calculated	custom fields
RoleCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
UsrCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(StoredSearch),rowid(Company),rowid(Role),rowid(Usr)

Internal usage

unused

Sample code: how to call this query through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BStoredSearch".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectStoredSearch".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bstoredsearch.selectstoredsearch.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
vhParameter:buffer-create().

assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.