project QadFinancials > class BCompany > 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 company can be found (based on its code), the existing company is updated.
If not, a new company is created.

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

PostCondition

After the execution of the method the records in the temp-tables are created/modified in the database. In case of a delete action (tc_status = 'D'), the records are removed from the database.


Parameters


tApiCompanyinputtemp-tableTemp-table to pass the company information.
tApiCompanyPropertyRefinputtemp-tableTemp-table to pass the company property information.
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/bcompany.p)

/* =================================================== */
/* Method Info:                                        */
/* Company will be loaded based on the Logical Key     */
/* =================================================== */
assign vcCompanyMsg = '':U.

/* ============================================================================ */
/* Clear the instance:                                                          */
/* this will also clear the t_s tables that were filled in ApiMaintainByDataSet */
/* ============================================================================ */
<M-10 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BCompany>
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 vcCompanyMsg   = trim(subst(#T-29'Entity integration: the specified action (&1) should be in the list &2.':255(1288)t-29#,trim(icAction),"{&DAEMONACTION-SAVESTORE},{&DAEMONACTION-SAVE},{&DAEMONACTION-STORE},{&DAEMONACTION-VALIDATE}":U))
           oiReturnStatus = -1.
           <M-11 run SetMessage (input  vcCompanyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2704':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCompany>
    return.
end. /* if icAction */

/* ======================== */
/* Count main-table records */
/* ======================== */
for each tApiCompany no-lock :
    assign viMainTableRecordCount = viMainTableRecordCount + 1.
end. /* for each */
if viMainTableRecordCount = 0
then do:
    assign vcCompanyMsg       = trim(#T-30'Entity integration: no main table records (Entity) found.':255(1289)T-30#)
           oiReturnStatus = -1.
           <M-12 run SetMessage (input  vcCompanyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2705':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCompany>
    return.
end. /* if viMainTableRecordCount */

/* ========================= */
/* Start Queries             */
/* ========================= */
<Q-17 run CompanyPrim (Start) in BCompany >

/* ================================ */
/* Start loop on main-table records */
/* ================================ */
for each tApiCompany by tApiCompany.tc_Rowid : 

    MAIN-BLOCK: DO:

    /* ========== */
    /* Initialize */
    /* ========== */
    assign vcCompanyMsg    = "":U
           vcRowID         = "":U
           vlWarningsFound = false
           vlSaveAsDraft   = icAction = {&DAEMONACTION-STORE}.
    
    /* =========================================== */
    /* Get the Company_ID based on the logical key */
    /* =========================================== */
    if (tApiCompany.Company_ID = ?    or
        tApiCompany.Company_ID = 0)   and
        tApiCompany.CompanyCode <> "" and
        tApiCompany.CompanyCode <> ?
    then do:
        <Q-19 run CompanyPrim (all) (Read) (NoCache)
          (input ?, (LookupCompanyId)
           input tApiCompany.CompanyCode, (CompanyCode)
           output dataset tqCompanyPrim) in BCompany >
        find tqCompanyPrim where 
             tqCompanyPrim.tcCompanyCode = tApiCompany.CompanyCode             
             no-lock no-error.
        if available tqCompanyPrim
        then assign tApiCompany.Company_ID = tqCompanyPrim.tiCompany_ID.
    end.

    /* ==================== */
    /* Load/Create Company  */
    /* ==================== */
    if tApiCompany.Company_ID = ? or
       tApiCompany.Company_ID = 0
    then assign viFcReturnSuper = -4.
    else do:  
        <M-21 run DataLoad (input  ? (icRowids), 
                    input  string(tApiCompany.Company_ID) (icPkeys), 
                    input  ? (icObjectIds), 
                    input  ? (icFreeform), 
                    input  false (ilKeepPrevious), 
                    output viFcReturnSuper (oiReturnStatus)) in BCompany>        
    end. /* Not if tApiCompany.Company_ID = ? or */
    if viFcReturnSuper = -4
    then do:
        assign viFcReturnSuper = 0.
        <M-22 run DataNew (output viFcReturnSuper (oiReturnStatus)) in BCompany>
        if viFcReturnSuper < 0
        then assign vcCompanyMsg = trim(subst(#T-31'Cannot create a new instance. Error number: &1.':255(308)t-31#, string(viFcReturnSuper))).
        find first tCompany no-error.
    end.
    else do:
        if viFcReturnSuper < 0
        then assign vcCompanyMsg = trim(subst(#T-32'Cannot load the instance (error number: &1, instance ID: &2).':255(289)t-32#, string(viFcReturnSuper), string(tApiCompany.Company_ID))).
        else do:
            find tCompany where
                 tCompany.Company_ID = tApiCompany.Company_ID
                 no-error.
            if not available tCompany
            then assign vcCompanyMsg = trim(subst(#T-33'Cannot find the instance after it has been loaded (instance ID: &1).':255(290)t-33#, string(tApiCompany.Company_ID))).
            else assign tCompany.tc_Status = "C":U.
         end. /* Not if viFcReturnSuper <> 0 */
    end. /* Not if viFcReturnSuper = -4 */

    /* ====================================== */
    /* Check for errors in the previous block */
    /* ====================================== */
    if vcCompanyMsg <> "":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-13 run SetMessage (input  vcCompanyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2706':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCompany>
        leave MAIN-BLOCK.
    end. /* if vcMessage <> "":U */
    
    /* ====================== */
    /* Copy data for Company  */
    /* ====================== */          
    buffer-copy tApiCompany
         except tApiCompany.Company_ID
                tApiCompany.tc_ParentRowid
                tApiCompany.tc_Rowid
                tApiCompany.tc_Status           
             to tCompany.
    if tCompany.tc_Status = "N":U
    then assign tCompany.CompanyCode = tApiCompany.CompanyCode.
    assign vcRowID                = tCompany.tc_Rowid
           tApiCompany.Company_ID = tCompany.Company_ID /* Needed to set the prim-key after the Save */.

    /* =========================================== */
    /* Process all Child tables (CountryVatFormat) */
    /* =========================================== */
    <M-27 run ApiStdMaintainTTDetail (input  icAction (icAction), 
                                  input-output ocLstReturn (bcLstReturn), 
                                  input-output ocLstPrimkey (bcLstPrimKey), 
                                  input-output ocLstRowid (bcLstRowid), 
                                  input-output vlSaveAsDraft (blSaveAsDraft), 
                                  output viFcReturnSuper (oiReturnStatus)) in BCompany>
    if viFcReturnSuper < 0
    then leave MAIN-BLOCK.
    else if viFcReturnSuper > 0
         then assign vlWarningsFound = true.

    /* =================================================== */
    /* 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. /* if vlSaveAsDraft */
    
    /* =============================== */
	/* Set Actvity                     */
	/* =============================== */
	if can-find (first tCompany where
			           tCompany.tc_Status = "N":U)
	then assign vcActivityCode = "Create":U.
	else if can-find (first tCompany where
				            tCompany.tc_Status = "C":U)
	then assign vcActivityCode = "Modify":U.

    /* ================= */
    /* Validate the data */
    /* ================= */
    <M-23 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BCompany>
    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. /* if viFcReturnSuper <> 0 */
    else if viFcReturnSuper > 0
         then assign vlWarningsFound = true.
    
    /* ================ */
    /* External updates */
    /* ================ */
    <M-24 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BCompany>
    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. /* if viFcReturnSuper <> 0 */
    else if viFcReturnSuper > 0
         then assign vlWarningsFound = true.
    
    /* ============= */
    /* Save the data */
    /* ============= */
    if icAction <> {&DAEMONACTION-VALIDATE}
    then do :
        <M-25 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BCompany>
        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. /* if viFcReturnSuper <> 0 */
        else if viFcReturnSuper > 0
             then assign vlWarningsFound = true.
    end. /* if icAction <> {&DAEMONACTION-VALIDATE} */
    
    /* ============================================ */
    /* 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(tApiCompany.Company_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(substr(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 vcCompanyMsg  = trim(#T-34'Only one draft instance can be created per method call.':255(858)T-34#) + chr(10) + trim(#T-35'This second object will not be stored as a draft instance and so is an error.':255(859)t-35#).
            <M-28 run SetMessage (input  vcCompanyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2874':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCompany>
            next.
        end. /* if vlDraftInstanceCreated = true */
        <M-26 run StoreState
          (input  '(':U + string(tCompany.CompanyCode) + ') ':U + trim(#T-36'Entity created via an API method.':200(1290)t-36#) (icDescription), 
           input  ? (icUIClass), 
           output viFcReturnSuper (oiReturnStatus)) in BCompany>
        assign vlDraftInstanceCreated                                         = true
               entry(num-entries(ocLstReturn , chr(4)), ocLstReturn , chr(4)) = string(viFcReturnSuper)
               entry(num-entries(ocLstPrimKey, chr(4)), ocLstPrimKey, chr(4)) = string(tApiCompany.Company_ID)
               entry(num-entries(ocLstRowid  , chr(4)), ocLstRowid  , chr(4)) = vcRowID.
    end. /* if vlSaveAsDraft and substr */
        
end. /* for each tApiCompany */

/* ========================= */
/* Stop Queries              */
/* ========================= */
<Q-18 run CompanyPrim (Stop) in BCompany >

/* ============================================================ */
/* 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 vcCompanyMsg   = trim(#T-37'Entity integration: incomplete information returned by an API method. See other messages for further details.':200(1291)T-37#) + chr(10) + 
                            trim(substitute(#T-38'Main table records: &1.':255(310)T-38#,string(viMainTableRecordCount))) + chr(10) + 
                            trim(substitute(#T-39'Return Statuses: &1.':255(311)T-39#,ocLstReturn))  + chr(10) +
                            trim(substitute(#T-40'Primary keys: &1.':255(312)T-40#,ocLstPrimKey)) + chr(10) +
                            trim(substitute(#T-41'Row IDs: &1.':255(313)T-41#,ocLstRowid)).
           oiReturnStatus = -3.
   <M-14 run SetMessage (input  vcCompanyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2707':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCompany>
    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 vcCompanyMsg      = trim(#T-42'An error has occurred while running this API method. See other error messages for more details.':255(301)T-42#)
               oiReturnStatus    = -1.
         <M-15 run SetMessage (input  vcCompanyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'E':U (icType),
                     input  1 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2708':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCompany>
    end. /* if index(ocLstReturn,"-":U) <> 0 */
    else do : 
        assign vcCompanyMsg     = trim(#T-43'A warning has occurred while running this API method. See other error messages for more details.':255(302)T-43#)
               oiReturnStatus   = +1.
        <M-16 run SetMessage (input  vcCompanyMsg (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'W':U (icType),
                     input  3 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2709':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BCompany>
    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 = "BCompany".
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/bcompany.apistdmaintaintt.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icAction = <parameter value>.

vhParameter = vhInputDS:get-buffer-handle("tApiCompany").
vhParameter:buffer-create().
assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

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