method apiGetStoredSearch

Description

get stored search

Parameters

iiStoredSearchId	input	integer	id
oiRowsToRetrieve	output	integer	RowsToRetrieve
ocSortColumn	output	character	SortColumn
olFilterPanelsMinimized	output	logical	FilterPanelsMinimized
olFreezeFirstColumn	output	logical	FreezeFirstColumn
olUseGridLayout	output	logical	use grid lay-out
olCompanyDependent	output	logical
olAutoApplyFilter	output	logical	auto apply filter on opening lookup
oiAccessLevel	output	integer
ocLayoutXML	output	character	grid lay-out in XML format
tFilterFields	output	temp-table	Filter fields
tResultFields	output	temp-table	Result fields
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program3/bstoredsearch.p)

if oiReturnStatus = 0
then oiReturnStatus = -98.

empty temp-table tFilterFields.
empty temp-table tResultFields.

<M-1 run DataLoad (input  '' (icRowids), 
                   input  string (iiStoredSearchId) (icPkeys), 
                   input  '' (icObjectIds), 
                   input  '' (icFreeform), 
                   input  no (ilKeepPrevious), 
                   output viFcReturnSuper (oiReturnStatus)) in BStoredSearch>
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

find first tStoredSearch no-error.
if available tStoredSearch
then do:
    assign oiRowsToRetrieve        = tStoredSearch.StoredSearchRowsToRetrieve
           ocSortColumn            = tStoredSearch.StoredSearchSortColumn
           olFilterPanelsMinimized = tStoredSearch.StoredSearchFilterMinimize
           olFreezeFirstColumn     = tStoredSearch.StoredSearchFreezeFirstCol
           olUseGridLayout         = tStoredSearch.StoredSearchUseGridLayout
           olCompanyDependent      = (tStoredSearch.Company_ID = viCompanyId)
           olAutoApplyFilter       = tStoredSearch.StoredSearchAutoApply
           oiAccessLevel           = (if tStoredSearch.Usr_ID = 0
                                      then if tStoredSearch.Role_ID = 0
                                           then {&CONTROLPROPERTYLAYERTYPE-SYSTEM}
                                           else {&CONTROLPROPERTYLAYERTYPE-ROLE}
                                      else {&CONTROLPROPERTYLAYERTYPE-USER})
           ocLayoutXML             = tStoredSearch.StoredSearchLayoutXML.

    <M-2 run GetFields (input  tStoredSearch.StoredSearchLookupRef (icLookupReference), 
                    input  tStoredSearch.tc_Rowid (icSSRowid), 
                    output viFcReturnSuper (oiReturnStatus)) in BStoredSearch>
    if viFcReturnSuper <> 0
    then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0
    then return.
end.

if oiReturnStatus = -98
then oiReturnStatus = 0.

Sample code: how to call this method 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 = "apiGetStoredSearch".
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.apigetstoredsearch.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiStoredSearchId = <parameter value>.

/* 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.