project QadFinancials > class BAltCOAStruct > method DataLoadByInput

Description

This method loads database records corresponding to input values (records found in the t_s*** tables).
When nothing found in the database, a new record should be initialised.
Input values should also be updated with :
- identity fields (override input values)
- tc_Rowid / tc_ParentRowid / tc_Status

Annotation

This template can be used to implement the code for this method.

* Replace [MainTableName] with the name of the main table in the class dataset (no prefixes).
* This template assumes that the main table has an identity field, and this field is the only field of the primary index of the table. Replace [PrimaryKeyFieldName] with the name of this field.
* This template assumes that the table has one logical alternate key (a key that is visible and editable to end-users) with one field. Replace [LogicalKeyFieldName] with the name of this field. If the logical key contains more than one field, repeat the code with this tag for every field in the key.
* The run statement following [METHOD CALL] should not be copied literally, but inserted as a method call (run the method in your own component).




for each t_s[MainTableName] by rowid(t_s[MainTableName]) on error undo, throw:

/* ================================================================= */
/* Lookup object by logical key */
/* When in create mode, skip lookup. */
/* ================================================================= */
if vcActivityCode <> "Create":U
then do:
vcFreeform = "for each [MainTableName] where [MainTableName].[LogicalKeyFieldName] = '":U + t_s[MainTableName].[LogicalKeyFieldName] + "'":U.
[METHOD CALL]
run DataLoad
(input '' (icRowids),
input '' (icPkeys),
input '' (icObjectIds),
input vcFreeform (icFreeform),
input yes (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus))
if viFcReturnSuper >= 0
then do:
/* DataLoad succeeded, no no-error needed */
find first t[MainTableName] where t[MainTableName].[LogicalKeyFieldName] = t_s[MainTableName].[LogicalKeyFieldName].
if t[MainTableName].tc_Status <> ""
then do:
[METHOD CALL]
run SetMessage
(input [duplicate key error] (icMessage),
input t_s[MainTableName].[LogicalKeyFieldName] (icArguments),
input 't[MainTableName].[LogicalKeyFieldName]':U (icFieldName),
input t_s[MainTableName].[LogicalKeyFieldName] (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input t_s[MainTableName].tc_Rowid (icRowid),
input 'ERR-xyz':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus))
assign oiReturnStatus = -1.
return.
end.
end.
end.

/* ================================================================= */
/* When in delete mode, ignore input data. */
/* When object not found, do not return an error. */
/* ================================================================= */
if vcActivityCode = "Delete":U
then do:
if viFcReturnSuper = -4
then delete t_s[MainTableName].
else do:
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

/* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
[METHOD CALL]
run SetRowidConvert
(input t_s[MainTableName].tc_Rowid (icOldRowid),
input t[MainTableName].tc_Rowid (icNewRowid),
output viFcReturnSuper (oiReturnStatus))

/* ================================================================= */
/* Update input to allow correct matching */
/* ================================================================= */
assign t_s[MainTableName].tc_Rowid = t[MainTableName].tc_Rowid
t_s[MainTableName].tc_ParentRowid = ""
opPrimeKey = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
+ string(t[MainTableName].[PrimaryKeyFieldName]).
end.

next.
end.

if vcActivityCode = "Create":U
or viFcReturnSuper = -4
then do:
/* ================================================================= */
/* When object not found and in modify only mode, return an error. */
/* ================================================================= */
if vcActivityCode = "Modify":U
then do:
[METHOD CALL]
run SetMessage
(input #T'Object with key $1 does not exist.':100T# (icMessage),
input t_s[MainTableName].[LogicalKeyFieldName] (icArguments),
input 't[MainTableName].[LogicalKeyFieldName]':U (icFieldName),
input t_s[MainTableName].[LogicalKeyFieldName] (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input t_s[MainTableName].tc_Rowid (icRowid),
input 'ERR-xyz':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus))
assign oiReturnStatus = -1.
return.
end.

/* ================================================================= */
/* When object not found or in create mode, create it. */
/* ================================================================= */
[METHOD CALL]
run AddDetailLine
(input '[MainTableName]':U (icTable),
input '' (icParentRowid),
output viFcReturnSuper (oiReturnStatus))

/* ================================================================= */
/* Update input to allow correct matching */
/* ================================================================= */
assign t_s[MainTableName].tc_Status = "N":U.
end.
else do:
/* ================================================================= */
/* Update input to allow correct matching */
/* ================================================================= */
assign t_s[MainTableName].tc_Status = "C":U
t[MainTableName].tc_Status = "C":U.
end.

if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

/* insert code for subtables here */

/* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
[METHOD CALL]
run SetRowidConvert
(input t_s[MainTableName].tc_Rowid (icOldRowid),
input t[MainTableName].tc_Rowid (icNewRowid),
output viFcReturnSuper (oiReturnStatus))

/* ================================================================= */
/* override value for identity fields in input */
/* ================================================================= */
assign t_s[MainTableName].[PrimaryKeyFieldName] = t[MainTableName].[PrimaryKeyFieldName]

/* ================================================================= */
/* Update input to allow correct matching */
/* ================================================================= */
t_s[MainTableName].tc_Rowid = t[MainTableName].tc_Rowid
t_s[MainTableName].tc_ParentRowid = ""

opPrimeKey = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
+ string(t[MainTableName].[PrimaryKeyFieldName]).
end.






If the class dataset contains more than one table, insert this code for every additional table.

/* ================================================================= */
/* Delete existing detail */
/* ================================================================= */
for each t[ChildTableName] where
t[ChildTableName].tc_ParentRowid = t[ParentTableName].tc_Rowid:
assign t[ChildTableName].tc_Status = "D":U.
end.

/* ================================================================= */
/* Update / add detail */
/* ================================================================= */
for each t_s[ChildTableName] where
t_s[ChildTableName].tc_ParentRowid = t_s[ParentTableName].tc_Rowid
on error undo, throw:

find first t[ChildTableName] where
t[ChildTableName].tc_ParentRowid = t[ParentTableName].tc_Rowid and
t[ChildTableName].[LogicalKeyFieldName] = t_s[ChildTableName].[LogicalKeyFieldName] no-error.
if available t[ChildTableName]
then if t[ChildTableName].tc_Status = "D":U
then assign t_s[ChildTableName].tc_Status = "C":U
t[ChildTableName].tc_Status = "C":U.
else do:
[METHOD CALL]
run SetMessage
(input [duplicate key error] (icMessage),
input t_s[ChildTableName].[LogicalKeyFieldName] (icArguments),
input 't[ChildTableName].[LogicalKeyFieldName]':U (icFieldName),
input t_s[ChildTableName].[LogicalKeyFieldName] (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input t_s[ChildTableName].tc_Rowid (icRowid),
input 'ERR-xyz':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus))
assign oiReturnStatus = -1.
return.
end.
else do:
[METHOD CALL]
run AddDetailLine (input '[ChildTableName]':U (icTable),
input t[ParentTableName].tc_Rowid (icParentRowid),
output viFcReturnSuper (oiReturnStatus))
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.
assign t_s[ChildTableName].tc_Status = "N":U
t[ChildTableName].[LogicalKeyFieldName] = t_s[ChildTableName].[LogicalKeyFieldName].
end.

/* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
[METHOD CALL]
run SetRowidConvert
(input t_s[ChildTableName].tc_Rowid (icOldRowid),
input t[ChildTableName].tc_Rowid (icNewRowid),
output viFcReturnSuper (oiReturnStatus))

/* ================================================================= */
/* override value for identity fields in input */
/* ================================================================= */
assign t_s[ChildTableName].[ChildPrimaryKeyFieldName] = t[ChildTableName].[ChildPrimaryKeyFieldName]

/* ================================================================= */
/* Update input to allow correct matching */
/* ================================================================= */
t_s[ChildTableName].[ParentPrimaryKeyFieldName] = t[ChildTableName].[ParentPrimaryKeyFieldName]
t_s[ChildTableName].tc_Rowid = t[ChildTableName].tc_Rowid
t_s[ChildTableName].tc_ParentRowid = t[ParentTableName].tc_Rowid.
end.

PreCondition

The code of this method must always be overridden, not extended.

Parameters


opPrimeKeyoutputlongcharPrimary Key field value of loaded record(s).
Keys are chr(4) separated.
Key fields are chr(2) separated.
oiReturnStatusoutputintegerReturn status of the method.

Internal usage


unused

program code (program2/baltcoastruct.p)

if oiReturnStatus = 0
then oiReturnStatus = -98.

PROCESSBLOCK:
for each t_sAltCOAStruct:

    /* ================================================================= */
    /* Lookup object by logical key                                      */
    /* When in create mode, skip lookup.                                 */
    /* ================================================================= */
    if vcActivityCode <> "Create":U
    then do:
        vcFreeform = "for each AltCOAStruct where AltCOAStruct.AltCOAStructCode = '":U + t_sAltCOAStruct.AltCOAStructCode + "'":U.
        <M-3 run DataLoad
           (input  '':U (icRowids), 
            input  '':U (icPkeys), 
            input  '':U (icObjectIds), 
            input  vcFreeform (icFreeform), 
            input  true (ilKeepPrevious), 
            output viFcReturnSuper (oiReturnStatus)) in BAltCOAStruct>
        if viFcReturnSuper >= 0
        then find first tAltCOAStruct where 
                        tAltCOAStruct.AltCOAStructCode = t_sAltCOAStruct.AltCOAStructCode 
                        no-error.
    end. /* if vcActivityCode <> "Create":U */

    /* ================================================================= */
    /* When in delete mode, ignore input data.                           */
    /* When object not found, do not return an error.                    */
    /* ================================================================= */
    if vcActivityCode = "Delete":U
    then do:
        if viFcReturnSuper = -4
        then delete t_sAltCOAStruct.
        else do:
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then leave PROCESSBLOCK.
    
            /* ================================================================= */
            /* Update input to allow correct matching                            */
            /* ================================================================= */
            assign t_sAltCOAStruct.tc_Rowid  = tAltCOAStruct.tc_Rowid
                   t_sAltCOAStruct.tc_ParentRowid = ""
                   opPrimeKey   = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                                + string(tAltCOAStruct.AltCOAStruct_ID).
        end.

        next.
    end.

    if vcActivityCode = "Create":U
    or viFcReturnSuper = -4
    then do:
        /* ================================================================= */
        /* When object not found and in modify only mode, return an error.   */
        /* ================================================================= */
        if vcActivityCode = "Modify":U
        then do:
            assign
                vcMessage = trim(#T-1'Object with key $1 does not exist.':100(48021)T-1#).
            <M-4 run SetMessage
               (input  vcMessage (icMessage), 
                input  t_sAltCOAStruct.AltCOAStructCode (icArguments), 
                input  't_sAltCOAStruct.AltCOAStructCode':U (icFieldName), 
                input  tAltCOAStruct.AltCOAStructCode (icFieldValue), 
                input  'E':U (icType), 
                input  3 (iiSeverity), 
                input  t_sAltCOAStruct.tc_Rowid (icRowid), 
                input  'QadFin-8875':U (icFcMsgNumber), 
                input  '':U (icFcExplanation), 
                input  '':U (icFcIdentification), 
                input  '':U (icFcContext), 
                output viFcReturnSuper (oiReturnStatus)) in BAltCOAStruct>            
            assign oiReturnStatus = -1.
            leave PROCESSBLOCK.
        end.

        /* ================================================================= */
        /* When object not found or in create mode, create it.               */
        /* ================================================================= */
        <M-5 run AddDetailLine
           (input  'AltCOAStruct':U (icTable), 
            input  '':U (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BAltCOAStruct>        
        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign t_sAltCOAStruct.tc_Status = "N":U.
    end.
    else do:
        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign t_sAltCOAStruct.tc_Status = "C":U.
    end.

    if viFcReturnSuper <> 0
    then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0
    then leave PROCESSBLOCK.

    assign t_sAltCOAStruct.AltCOAStruct_ID = tAltCOAStruct.AltCOAStruct_ID.

    /* insert code for subtables here */
    /* ================================================================= */
    /* Delete existing detail                                            */
    /* ================================================================= */
    for each tAltCOAStructDet where
             tAltCOAStructDet.tc_ParentRowid = tAltCOAStruct.tc_Rowid:
        assign tAltCOAStructDet.tc_Status = "D":U.
    end.

    /* ================================================================= */
    /* Update / add detail                                               */
    /* ================================================================= */
    for each t_sAltCOAStructDet where
             t_sAltCOAStructDet.tc_ParentRowid = t_sAltCOAStruct.tc_Rowid and
             t_sAltCOAStructDet.tc_Status     <> "D":U:
        assign t_sAltCOAStructDet.AltCOAStruct_ID = t_sAltCOAStruct.AltCOAStruct_ID.

        find first tAltCOAStructDet where
                   tAltCOAStructDet.AltCOAStructDetCode  = t_sAltCOAStructDet.AltCOAStructDetCode and
                   tAltCOAStructDet.AltCOAStruct_ID      = t_sAltCOAStructDet.AltCOAStruct_ID 
                   no-error.
        if available tAltCOAStructDet
        then assign t_sAltCOAStructDet.tc_Status          = "C":U
                    t_sAltCOAStructDet.AltCOAStructDet_ID = tAltCOAStructDet.AltCOAStructDet_ID.
        else do:    
            <M-7 run AddDetailLine
               (input  'AltCOAStructDet':U (icTable), 
                input  tAltCOAStruct.tc_Rowid (icParentRowid), 
                output viFcReturnSuper (oiReturnStatus)) in BAltCOAStruct>
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then leave PROCESSBLOCK.
            assign t_sAltCOAStructDet.tc_Status = "N":U.
        end.

        /* ================================================================= */
        /* override value for identity fields in input                       */
        /* ================================================================= */
        assign 
            t_sAltCOAStructDet.AltCOAStructDet_ID = tAltCOAStructDet.AltCOAStructDet_ID
            tAltCOAStructDet.AltCOAStructDetCode = t_sAltCOAStructDet.AltCOAStructDetCode 

            /* ================================================================= */
            /* Update input to allow correct matching                            */
            /* ================================================================= */
            t_sAltCOAStructDet.AltCOAStruct_ID     = tAltCOAStructDet.AltCOAStruct_ID
            t_sAltCOAStructDet.tc_Rowid            = tAltCOAStructDet.tc_Rowid
            t_sAltCOAStructDet.tc_ParentRowid      = tAltCOAStruct.tc_Rowid.
    end.
                      
    <I-11 {UpdateTransString
         &TABLE = "AltCOAStruct"}>
              
    /* get parent AltCOAStructDet ID */
    for each t_sAltCOAStructDet:
        if (t_sAltCOAStructDet.ParentAltCOAStructDet_ID = 0 or 
            t_sAltCOAStructDet.ParentAltCOAStructDet_ID = ?) and
            t_sAltCOAStructDet.tcParentAltCOAStructDetCode <> "":U and
            t_sAltCOAStructDet.tcParentAltCOAStructDetCode <> ?   
        then do:
             find first tAltCOAStructDet where tAltCOAStructDet.AltCOAStructDetCode = t_sAltCOAStructDet.tcParentAltCOAStructDetCode and
                                               tAltCOAStructDet.AltCOAStruct_ID = t_sAltCOAStructDet.AltCOAStruct_ID
                                               no-error.
             if available tAltCOAStructDet 
             then assign t_sAltCOAStructDet.ParentAltCOAStructDet_ID = tAltCOAStructDet.AltCOAStructDet_ID.
        end.        
    end.

    /* ================================================================= */
    /* override value for identity fields in input                       */
    /* ================================================================= */
    assign t_sAltCOAStruct.AltCOAStruct_ID = tAltCOAStruct.AltCOAStruct_ID

    /* ================================================================= */
    /* Update input to allow correct matching                            */
    /* ================================================================= */
    t_sAltCOAStruct.tc_Rowid       = tAltCOAStruct.tc_Rowid
    t_sAltCOAStruct.tc_ParentRowid = ""

    opPrimeKey       = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                      + string(tAltCOAStruct.AltCOAStruct_ID).
end.

if oiReturnStatus = -98
then oiReturnStatus = 0.