project QadFinancials > class BCOACrossRef > method ApiLoadCOACrossRef

Description

This method will retrieve all COA Cross Reference and COA Cross Reference Detail records (or the ones matching the input parameters Code and/or Type) for the current domain.
Both tables will be returned by the method.


Parameters


icCOACrossRefCodeinputcharacterCOA Cross Reference Code
icCOACrossRefTypeinputcharacterCOA Cross Reference Type
tApiCOACrossRefoutputtemp-tableCOA Cross Reference
tApiCOACrossRefDetoutputtemp-tableCOA Cross Reference Detail
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program9/bcoacrossref.p)

assign oiReturnStatus      = -98
       viLocalReturnStatus = 0.

/* ============= */
/* Start queries */
/* ============= */
<Q-6 run COACrossRefDetByIDParentID  (Start) in BCOACrossRef >

/* ==================================== */
/* Retrieve the Cross Reference records */
/* ==================================== */
<Q-1 run COACrossRefByAll (all) (Read) (NoCache)
   (input ?, (COACrossRefID)
    input viDomainID, (SourceDomainID)
    input ?, (TargetDomainID)
    input ?, (AltCOAStructID)
    input icCOACrossRefCode, (COACrossRefCode)
    input icCOACrossRefType, (COACrossRefType)
    input ?, (COACrossRefIsActive)
    input ?, (SourceDomainCode)
    input ?, (TargetDomainCode)
    input ?, (AltCOAStructCode)
    output dataset tqCOACrossRefByAll) in BCOACrossRef >

/* ================================================== */
/* Loop through main method and create output records */
/* ================================================== */
for each tqCOACrossRefByAll:
    create tApiCOACrossRef.
    <M-2 run BufferCopy
       (input  buffer tqCOACrossRefByAll:handle (ihFrom), 
        input  buffer tapicOACrossRef:handle (ihTo), 
        output viFcReturnSuper (oiReturnStatus)) in BCOACrossRef>

    if viFcReturnSuper <  0 or 
       (viFcReturnSuper > 0 and viLocalReturnStatus = 0)
    then assign viLocalReturnStatus = viFcReturnSuper.

    /* ===================================================== */
    /* Loop through detail records and create output records */
    /* Link the detail records to the main records.          */
    /* ===================================================== */
    <Q-4 run COACrossRefDetByIDParentID (all) (Read) (NoCache)
       (input tqCOACrossRefByAll.tiCOACrossRef_ID, (COACrossRefID)
        input ?, (COACrossRefDetID)
        input ?, (CompanyId)
        output dataset tqCOACrossRefDetByIDParentID) in BCOACrossRef >
    for each tqCOACrossRefDetByIDParentID where
             tqCOACrossRefDetByIDParentID.tiCOACrossRef_ID = tqCOACrossRefByAll.tiCOACrossRef_ID:
        create tApiCOACrossRefDet.
        <M-5 run BufferCopy
           (input  buffer tqCOACrossRefDetByIDParentID:handle (ihFrom), 
            input  buffer tApiCOACrossRefDet:handle (ihTo), 
            output viFcReturnSuper (oiReturnStatus)) in BCOACrossRef>
        if viFcReturnSuper <  0 or 
           (viFcReturnSuper > 0 and viLocalReturnStatus = 0)
        then assign viLocalReturnStatus = viFcReturnSuper.

        assign tApiCOACrossRefDet.tc_ParentRowid = tApiCOACrossRef.tc_Rowid.
    end. /* for each tqCOACrossRefDetByIDParentID where */
end. /* for each tqCOACrossRefByAll: */

/* ============ */
/* Stop queries */
/* ============ */
<Q-7 run COACrossRefDetByIDParentID  (Stop) in BCOACrossRef >

assign oiReturnStatus = viLocalReturnStatus.


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 = "BCOACrossRef".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiLoadCOACrossRef".
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/bcoacrossref.apiloadcoacrossref.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icCOACrossRefCode = <parameter value>
       vhParameter::icCOACrossRefType = <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.