project QadFinancials > class BCountry > method ApiLoadCountry

Description

This method will return all country records for the sharedset of the company that was passed as input parameter. If the company parameter is left blank, all countries are returned.
This method is used on the UI for Excel Integration. It returns all Countries' so they can be shown in the Excel Integration grid.


Parameters


tApiCountryoutputtemp-tableCourntry codes that are loaded
tApiCountryVatFormatoutputtemp-tableCountry Tax formats that are loaded
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program3/bcountry.p)

assign oiReturnStatus = -98
       viLocalStatus  = 0.

empty temp-table tApiCountry.

/*retrieve all the records of Country within the domain */
<Q-1 run CountryByIDAllInfo (all) (Read) (NoCache)
   (input ?, (Country_ID)
    output dataset tqCountryByIDAllInfo) in BCountry >

/* Create tApiCountry records */
for each tqCountryByIDAllInfo:
    create tApiCountry.
    <M-2 run BufferCopy
       (input  buffer tqCountryByIDAllInfo:handle (ihFrom), 
        input  buffer tApiCountry:handle (ihTo), 
        output viFcReturnSuper (oiReturnStatus)) in BCountry>
    assign tApiCountry.tcCurrencyCode = <M-3 ApiLoadCountryCurrencyCode  (input  tApiCountry.Currency_ID (iiCurrencyId)) in BCountry>
           tApiCountry.tcBLWICountryCode = <M-4 ApiLoadCountryBLWCode  (input  tApiCountry.BLWICountry_ID (iiBLWCountryId)) in BCountry>.
    
    if viFcReturnSuper <  0 or 
       viFcReturnSuper <> 0 and 
       viLocalStatus   =  0
    then assign viLocalStatus = viFcReturnSuper.
end.

<Q-5 run CountryVatFormatForExcel (all) (Read) (NoCache)  (output dataset tqCountryVatFormatForExcel) in BCountry >
for each tqCountryVatFormatForExcel,
    first tApiCountry where tApiCountry.Country_ID = tqCountryVatFormatForExcel.tiCountry_ID:
    create tApiCountryVatFormat.
    <M-6 run BufferCopy
       (input  buffer tqCountryvatFormatforExcel:handle (ihFrom), 
        input  buffer tApiCountryVatFormat:handle (ihTo), 
        output viFcReturnSuper (oiReturnStatus)) in BCountry>
    assign tApiCountryVatFormat.tc_ParentRowid = tApiCountry.tc_Rowid.
end. /* for each tqCountryVatFormatForExcel */

assign oiReturnStatus = viLocalStatus.


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 = "BCountry".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiLoadCountry".
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 = "".

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