project QadFinancials > class BBudgetLinkActual > method ApiUpdateBudgetLinkActualRep

Description

ApiUpdateBudgetLinkActualReportPeriodID


Parameters


tNewBudgetLinkActualinputtemp-tableNewBudgetLinkActual; table containing the information of the records wherefor the ReportPeriod_ID should be updated
The load is performed based on BudgetLinkActual_ID in the input-table records and only field ReportPeriod_ID is copied into the instance-table.
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program8/bbudgetlinkactual.p)

/* ================================================================ */
    /* Return if no data is passed                                      */
    /* ================================================================ */
    if not can-find (first tNewBudgetLinkActual) 
    then return.
    
    /* ================================================================ */
    /* Set Return-status = Default-error                                */
    /* ================================================================ */
    assign oiReturnStatus = -98.
    
    /* ================================================================ */
    /* Compose a string that contains all the IDs to be loaded          */
    /* ================================================================ */
    for each tNewBudgetLinkActual : 
        assign vcBudgetLinkActualToLoad = if vcBudgetLinkActualToLoad = "":U
                                          then string(tNewBudgetLinkActual.BudgetLinkActual_ID)
                                          else vcBudgetLinkActualToLoad + chr(4) + string(tNewBudgetLinkActual.BudgetLinkActual_ID).
    end. /* for each */

    /* ================================================================ */
    /* Perform a Load                                                   */
    /* ================================================================ */
    <M-6 run DataLoad
          (input  '':U (icRowids), 
           input  vcBudgetLinkActualToLoad (icPkeys), 
           input  '':U (icObjectIds), 
           input  '' (icFreeform), 
           input  false (ilKeepPrevious), 
           output viFcReturnSuper (oiReturnStatus)) in BBudgetLinkActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    
    /* ================================================================ */
    /* Go through the input and create a record for every input-record  */
    /* ================================================================ */
    for each tNewBudgetLinkActual : 
        find tBudgetLinkActual where 
             tBudgetLinkActual.BudgetLinkActual_ID = tNewBudgetLinkActual.BudgetLinkActual_ID
             no-error.
        if not available tBudgetLinkActual
        then do :
            assign oiReturnStatus = -3
                   vcMessage      = trim(substitute(#T-8'Internal error: cannot find the loaded record (&1) based on its ID (&2).':255(737)t-8#,"BudgetLinkActual":U,string(tNewBudgetLinkActual.BudgetLinkActual_ID))).
            <M-7 run SetMessage (input  vcMessage (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  3 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-1826':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BBudgetLinkActual>
            Return.
        end. /* if not available tBudgetLinkActual */
        assign tBudgetLinkActual.ReportPeriod_ID = tNewBudgetLinkActual.ReportPeriod_ID
               tBudgetLinkActual.tc_Status       = "C":U.
    end. /* for each tNewQQBudgetLinkActual */
    
    /* ================================================================ */
    /* Perfom Validation, AdditionalUpdates and DataSave                */
    /* ================================================================ */
    <M-3 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BBudgetLinkActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    <M-4 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BBudgetLinkActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    <M-5 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BBudgetLinkActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    
    /* ================================================================ */
    /* Set Return-status = OK                                           */
    /* ================================================================ */
    if oiReturnStatus = -98
    then assign 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 = "BBudgetLinkActual".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiUpdateBudgetLinkActualRep".
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/bbudgetlinkactual.apiupdatebudgetlinkactualrep.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tNewBudgetLinkActual").
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.