project QadFinancials > class BCurrency > method ApiStdMaintainTT

Description

This method can create new instances or update existing instances based on the content of the input temp-table.
The action that is passed as a parameter will define if the records are saved, saved as draft or just validated.

If the currency can be found (based on its code), the existing currency is updated.
If not, a new currency is created.

Each record in the main input temp-table will start a seperate transaction.


Parameters


tApiCurrencyinputtemp-tableTemp-table like currency with the records that need to be created or modified.
icActioninputcharacterThis input parameter defines what should happen with the input data:
- SAVE: Save the data if there were no errors.
- SAVESTORE: Save the data if there were no errors. If there were, save as draft.
- STORE: Save the data as draft.
- VALIDATE: Validate the input data, but do not save the data.
oclstPrimKeyoutputcharacterReturns the list of IDs for all records that were processed.
ocLstReturnoutputcharacterReturns the list of returnvalues for all records that were processed.
ocLstRowidoutputcharacterReturns the list of Rowids for each records that was processed.
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program7/bcurrency.p)

/* =================================================== */
/* Method Info:                                        */
/* Currency will be loaded based on the Logical Key    */
/* =================================================== */

/* ============================================================================ */
/* Clear the instance:                                                          */
/* this will also clear the t_s tables that were filled in ApiMaintainByDataSet */
/* ============================================================================ */
<M-1 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BCurrency>
if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.
if oiReturnStatus < 0
then return.

/* ==================== */
/* Set Default Return   */
/* Parameter Validation */
/* ==================== */
assign oiReturnStatus = -98
       vlDraftInstanceCreated = false.
if icAction = ? then assign icAction = "":U.
if icAction <> {&DAEMONACTION-SAVESTORE} and
   icAction <> {&DAEMONACTION-SAVE}      and
   icAction <> {&DAEMONACTION-STORE}     and
   icAction <> {&DAEMONACTION-VALIDATE}
then do:
    assign vcCurrencyMsg   = trim(subst(#T-17'Currency integration: the specified action &1 should be in the list &2.':255(1598)t-17#,trim(icAction),"{&DAEMONACTION-SAVESTORE},{&DAEMONACTION-SAVE},{&DAEMONACTION-STORE},{&DAEMONACTION-VALIDATE}":U))
           oiReturnStatus = -1.
           <M-2 run SetMessage (input  vcCurrencyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2609':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCurrency> 
           
    
    return.
end. /* if icAction */

/* ======================== */
/* Count main-table records */
/* ======================== */
for each tApiCurrency no-lock :
    assign viMainTableRecordCount = viMainTableRecordCount + 1.
end. /* for each */
if viMainTableRecordCount = 0
then do:
    assign vcCurrencyMsg       = trim(#T-18'Currency integration: no main currency table records found.':255(1599)t-18#)
           oiReturnStatus = -1.
           <M-3 run SetMessage (input  vcCurrencyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2610':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCurrency> 
    return.
end. /* if viMainTableRecordCount */

<Q-8 run CurrencyPrim (Start) in BCurrency >
/* ================================ */
/* Start loop on main-table records */
/* ================================ */
for each tApiCurrency by tApiCurrency.tc_Rowid: 

    MAIN-BLOCK:
    DO:

    /* ========== */
    /* Initialize */
    /* ========== */
    assign vcCurrencyMsg       = "":U
           vcRowID             = "":U
           vlWarningsFound     = false
           vlSaveAsDraft       = icAction = {&DAEMONACTION-STORE}.
    

    /* ====================================== */
    /* Get the Currency_ID based on the logical key */
    /* ====================================== */
    if (tApiCurrency.Currency_ID = ?    or
        tApiCurrency.Currency_ID = 0)   and
        tApiCurrency.CurrencyCode <> "" and
        tApiCurrency.CurrencyCode <> ?
    then do:
        <Q-9 run CurrencyPrim (all) (Read) (NoCache)
          (input tApiCurrency.CurrencyCode, (CurrencyCode)
           input ?, (Currency_ID)
           output dataset tqCurrencyPrim) in BCurrency >
        
        find tqCurrencyPrim where 
             tqCurrencyPrim.tcCurrencyCode = tApiCurrency.CurrencyCode             
             no-lock no-error.
        if available tqCurrencyPrim
        then assign tApiCurrency.Currency_ID = tqCurrencyPrim.tiCurrency_ID.
    end.

    /* ==================== */
    /* Load/Create Currency  */
    /* ==================== */
    if tApiCurrency.Currency_ID = ? or
       tApiCurrency.Currency_ID = 0
    then assign viFcReturnSuper = -4.
    else do:
        
        <M-10 run DataLoad (input  ? (icRowids), 
                    input  string(tApiCurrency.Currency_ID) (icPkeys), 
                    input  ? (icObjectIds), 
                    input  ? (icFreeform), 
                    input  false (ilKeepPrevious), 
                    output viFcReturnSuper (oiReturnStatus)) in BCurrency>        
    end.
    if viFcReturnSuper = -4
    then do:
        assign viFcReturnSuper = 0.
        <M-11 run DataNew (output viFcReturnSuper (oiReturnStatus)) in BCurrency>
                
        if viFcReturnSuper < 0
        then assign vcCurrencyMsg = trim(subst(#T-19'Cannot create a new instance. Error number: &1.':255(308)t-19#, string(viFcReturnSuper))).

        find first tCurrency no-error.
    end.
    else do:
        if viFcReturnSuper < 0
        then assign vcCurrencyMsg = trim(subst(#T-20'Cannot load the instance (error number: &1, instance ID: &2).':255(289)t-20#, string(viFcReturnSuper), string(tApiCurrency.Currency_ID))).
        else do:
            find tCurrency where
                 tCurrency.Currency_ID = tApiCurrency.Currency_ID
                 no-error.
            if not available tCurrency
            then assign vcCurrencyMsg = trim(subst(#T-21'Cannot find the instance after it has been loaded (instance ID: &1).':255(290)t-21#,
                                               string(tApiCurrency.Currency_ID))).
            else assign tCurrency.tc_Status = "C":U.
        end.
    end.

    /* ================================================================= */
    /* Check for errors in the previous block                            */
    /* ================================================================= */

    if vcCurrencyMsg <> "":U
    then do:
        assign ocLstReturn   = ocLstReturn  + chr(4) + (if viFcReturnSuper = 0 then "-3":U else string(viFcReturnSuper))
               ocLstPrimKey  = ocLstPrimKey + chr(4) + "*":U
               ocLstRowid    = ocLstRowid   + chr(4) + "*":U 
               vlSaveAsDraft = false.

               <M-4 run SetMessage (input  vcCurrencyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2611':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCurrency> 
               
        leave MAIN-BLOCK.
    end.

    /* ====================== */
    /* Copy data for Currency  */
    /* ====================== */          
    
    buffer-copy tApiCurrency
         except tApiCurrency.Currency_ID
                tApiCurrency.tc_ParentRowid
                tApiCurrency.tc_Rowid
                tApiCurrency.tc_Status  
                tApiCurrency.CurrencyCode
             to tCurrency.

    if tCurrency.tc_Status = "N":U
    then assign tCurrency.CurrencyCode = tApiCurrency.CurrencyCode.
    
    assign vcRowID                  = tCurrency.tc_Rowid
           tApiCurrency.Currency_ID = tCurrency.Currency_ID /*Needed to set het prim-key after the save*/ . 

    
    /* =================================================== */
    /* This is where it ends if only SaveAsDraft is needed */
    /* =================================================== */
    if vlSaveAsDraft
    then do:
        assign ocLstReturn  = ocLstReturn  + chr(4) + "-1":U
               ocLstPrimKey = ocLstPrimKey + chr(4) + "*":U
               ocLstRowid   = ocLstRowid   + chr(4) + "*":U.

        leave MAIN-BLOCK.
    end.

    /* =============================== */
	/* Set Actvity                     */
	/* =============================== */
	if can-find (first tCurrency where
			           tCurrency.tc_Status = "N":U)
	then assign vcActivityCode = "Create":U.
	else if can-find (first tCurrency where
				            tCurrency.tc_Status = "C":U)
	then assign vcActivityCode = "Modify":U.

    /* ================= */
    /* Validate the data */
    /* ================= */
    <M-12 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BCurrency>
   
    if viFcReturnSuper < 0
    then do:   
        assign ocLstReturn   = ocLstReturn  + chr(4) + string(viFcReturnSuper)
               ocLstPrimKey  = ocLstPrimKey + chr(4) + "*":U
               ocLstRowid    = ocLstRowid   + chr(4) + "*":U
               vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and icAction <> {&DAEMONACTION-VALIDATE}).
        leave main-block.
    end.
    else if viFcReturnSuper > 0
    then assign vlWarningsFound = true.
    
    /* ================ */
    /* External updates */
    /* ================ */
    <M-13 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BCurrency>
    if viFcReturnSuper < 0
    then do:
        assign ocLstReturn   = ocLstReturn  + chr(4) + string(viFcReturnSuper)
               ocLstPrimKey  = ocLstPrimKey + chr(4) + "*":U
               ocLstRowid    = ocLstRowid   + chr(4) + "*":U
               vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and icAction <> {&DAEMONACTION-VALIDATE}).
        leave main-block.     
    end.
    else if viFcReturnSuper > 0
    then assign vlWarningsFound = true.

    /* ============= */
    /* Save the data */
    /* ============= */
    if icAction <> {&DAEMONACTION-VALIDATE}
    then do:
        <M-14 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BCurrency>
                
        if viFcReturnSuper < 0
        then do:   
            assign ocLstReturn   = ocLstReturn  + chr(4) + string(viFcReturnSuper)
                   ocLstPrimKey  = ocLstPrimKey + chr(4) + "*":U
                   ocLstRowid    = ocLstRowid   + chr(4) + "*":U
                   vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and icAction <> {&DAEMONACTION-VALIDATE}).                         
            leave main-block.
        end.
        else if viFcReturnSuper > 0
        then assign vlWarningsFound = true.
    end.
                
    /* ============================================ */
    /* Indicate that everything was saved correctly */
    /* ============================================ */
    assign ocLstReturn   = ocLstReturn  + chr(4) + (if vlWarningsFound = true then "1":U else "0":U)
           ocLstPrimKey  = ocLstPrimKey + chr(4) + string(tApiCurrency.Currency_ID)
           ocLstRowid    = ocLstRowid   + chr(4) + vcRowID.
    
    END. /* MAIN-BLOCK */

    /* ================================================================== */
    /* Handle errors: Store if SaveAsDraft is needed                      */
    /* Check: only 1 draft is allowed for a single bus-component instance */
    /* ================================================================== */
    if vlSaveAsDraft and
       index(substring(ocLstReturn,r-index(ocLstReturn,chr(4)) + 1, -1, "CHARACTER":U), "-":U) <> 0 /* Negative return-status for this entry*/
    then do:
        if vlDraftInstanceCreated = true
        then do:
            assign vcCurrencyMsg = trim(#T-30'Only one draft instance can be created per method call.':255(13856)T-30#) +
                                   chr(10) +
                                   trim(#T-31'This second object will not be stored as a draft instance and so is saved as an error.':255(13859)t-31#).
            <M-32 run SetMessage (input  vcCurrencyMsg (icMessage), 
                      input  '':U (icArguments), 
                      input  '':U (icFieldName), 
                      input  '':U (icFieldValue), 
                      input  'E':U (icType), 
                      input  1 (iiSeverity), 
                      input  '':U (icRowid), 
                      input  'QADFIN-3091':U (icFcMsgNumber), 
                      input  '' (icFcExplanation), 
                      input  '' (icFcIdentification), 
                      input  '' (icFcContext), 
                      output viFcReturnSuper (oiReturnStatus)) in BCurrency>
            next.
        end. /*if vlDraftInstanceCreated = true*/

        <M-16 run StoreState (input  '(':U + string(tCurrency.CurrencyCode) + ') ':U + trim(#T-22'Currency created via an API method.':200(1600)t-22#) (icDescription), 
                      input  ? (icUIClass), 
                      output viFcReturnSuper (oiReturnStatus)) in BCurrency>

        assign vlDraftInstanceCreated = true
               entry(num-entries(ocLstReturn , chr(4)), ocLstReturn , chr(4)) = string(viFcReturnSuper)
               entry(num-entries(ocLstPrimKey, chr(4)), ocLstPrimKey, chr(4)) = string(tApiCurrency.Currency_ID)
               entry(num-entries(ocLstRowid  , chr(4)), ocLstRowid  , chr(4)) = vcRowID.
    end.  /*if vlSaveAsDraft and index(substring*/   
end. /* for each tApiCode */

/* ================================================================= */
/*   Stop Queries                                                    */
/* ================================================================= */

<Q-15 run CurrencyPrim (Stop) in BCurrency >


/* ============================================================ */
/* Trim the first character of ocLstReturn and primkey          */
/* Check for correct number and format of the return-parameters */
/* ============================================================ */
if length(ocLstReturn,"CHARACTER":U)  > 1 then assign ocLstReturn  = substring(ocLstReturn,2,-1,"CHARACTER":U).
if length(ocLstPrimKey,"CHARACTER":U) > 1 then assign ocLstPrimKey = substring(ocLstPrimKey,2,-1,"CHARACTER":U).
if length(ocLstRowid,"CHARACTER":U)   > 1 then assign ocLstRowid   = substring(ocLstRowid,2,-1,"CHARACTER":U).
if num-entries(ocLstReturn,chr(4))  <> viMainTableRecordCount or
   num-entries(ocLstPrimKey,chr(4)) <> viMainTableRecordCount or
   num-entries(ocLstRowid,chr(4))   <> viMainTableRecordCount
then do :
    assign vcCurrencyMsg  = trim(#T-23'Currency integration: incomplete information returned by an API method. See other messages for further details.':200(1601)T-23#) + chr(10) + 
                            trim(substitute(#T-24'Main table records: &1.':255(310)T-24#,string(viMainTableRecordCount))) + chr(10) + 
                            trim(substitute(#T-25'Return Statuses: &1.':255(311)T-25#,ocLstReturn))  + chr(10) +
                            trim(substitute(#T-26'Primary keys: &1.':255(312)T-26#,ocLstPrimKey)) + chr(10) +
                            trim(substitute(#T-27'Row IDs: &1.':255(313)T-27#,ocLstRowid)).
           oiReturnStatus = -3.
   
    <M-5 run SetMessage (input  vcCurrencyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2612':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCurrency> 
    
    return.
end. /* if num-entries */


/* ===================================================== */
/* Set global return status based on the individual ones */
/* ===================================================== */
if ocLstReturn = substring(fill("0":U + CHR(4),viMainTableRecordCount),1,length(ocLstReturn,"CHARACTER":U),"CHARACTER":U)
then assign oiReturnStatus = 0.
else do : 
    if index(ocLstReturn,"-":U) <> 0
    then do :
        assign vcCurrencyMsg     = trim(#T-28'An error has occurred while running this API method. See other error messages for more details.':255(301)T-28#)
               oiReturnStatus    = -1.


         <M-7 run SetMessage (input  vcCurrencyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2614':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCurrency> 
         
    end. /* if index(ocLstReturn,"-":U) <> 0 */
    else do : 
        assign vcCurrencyMsg     = trim(#T-29'A warning has occurred while running this API method. See other error messages for more details.':255(302)T-29#)
               oiReturnStatus   = +1.
        <M-6 run SetMessage (input  vcCurrencyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'W':U (icType),
                     input  3 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2613':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCurrency> 
    end. /* not if lookup */
end. /* not if ocLstReturn */


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 = "BCurrency".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiStdMaintainTT".
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/bcurrency.apistdmaintaintt.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icAction = <parameter value>.

vhParameter = vhInputDS:get-buffer-handle("tApiCurrency").
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.