project QadFinancials > class BPaymentGroup > 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

Important : code of this method must be overridden, not extended.

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.



if oiReturnStatus = 0
then oiReturnStatus = -98.

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

/* ================================================================= */
/* 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.

/* ================================================================= */
/* Update input to allow correct matching */
/* ================================================================= */
assign t_s[MainTableName].tc_Rowid = t[MainTableName].tc_Rowid
t_s[MainTableName].tc_ParentRowid = ""
ocPrimeKey = (if ocPrimeKey = "" then "" else ocPrimeKey + 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 */

/* ================================================================= */
/* 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 = ""

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

if oiReturnStatus = -98
then oiReturnStatus = 0.






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:

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.

/* ================================================================= */
/* 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/bpaymentgroup.p)

if oiReturnStatus = 0
then oiReturnStatus = -98.

for each t_sPaymentGroup on error undo, return:

    /* ================================================================= */
    /* Lookup object by logical key                                      */
    /* When in create mode, skip lookup.                                 */
    /* ================================================================= */
    if vcActivityCode <> "Create":U
    then do:
    
        /* ============================================ */
        /* Get the PaymentGroup_ID based on the logical key   */
        /* ============================================ */
        if (t_sPaymentGroup.PaymentGroup_ID = ?    or
            t_sPaymentGroup.PaymentGroup_ID = 0)   and
            t_sPaymentGroup.PaymentGroupCode <> "" and
            t_sPaymentGroup.PaymentGroupCode <> ?
        then do:
            <Q-6 run PaymentGroupPrim (all) (Read) (NoCache)
               (input t_sPaymentGroup.PaymentGroup_ID, (PaymentGroupId)
                input t_sPaymentGroup.PaymentGroupCode, (PaymentGroupCode)
                output dataset tqPaymentGroupPrim) in BPaymentGroup >

            find tqPaymentGroupPrim where 
                 tqPaymentGroupPrim.tcPaymentGroupCode = t_sPaymentGroup.PaymentGroupCode             
                 no-lock no-error.
            if available tqPaymentGroupPrim
            then assign t_sPaymentGroup.PaymentGroup_ID = tqPaymentGroupPrim.tiPaymentGroup_ID.
        end. /* if t_sPaymentGroup.PaymentGroup_ID = ? or */
              
        /* ============================ */
        /* Load/Create PaymentGroup */
        /* ============================ */
        if t_sPaymentGroup.PaymentGroup_ID = ? or
           t_sPaymentGroup.PaymentGroup_ID = 0
        then assign viFcReturnSuper = -4.
        else do:
            <M-2 run DataLoad
               (input  '' (icRowids), 
                input  string(t_sPaymentGroup.PaymentGroup_ID) (icPkeys), 
                input  '' (icObjectIds), 
                input  '' (icFreeform), 
                input  yes (ilKeepPrevious), 
                output viFcReturnSuper (oiReturnStatus)) in BPaymentGroup>  
        end.  /* else do */            
        if viFcReturnSuper >= 0
        then find first tPaymentGroup where 
                        tPaymentGroup.PaymentGroup_ID = t_sPaymentGroup.PaymentGroup_ID 
                        no-error.
    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_sPaymentGroup.
        else do:
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then return.
    
            /* ================================================================= */
            /* Update input to allow correct matching                            */
            /* ================================================================= */
            assign t_sPaymentGroup.tc_Rowid       = tPaymentGroup.tc_Rowid
                   t_sPaymentGroup.tc_ParentRowid = ""
                   opPrimeKey                     = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                                                  + string(tPaymentGroup.PaymentGroup_ID).
        end. /* else do */

        next.
    end. /* if vcActivityCode = "Delete":U */

    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-5'Object with key $1 does not exist.':100(48021)T-5#).
            
            <M-3 run SetMessage
               (input  vcMessage (icMessage), 
                input  t_sPaymentGroup.PaymentGroupCode (icArguments), 
                input  'tPaymentGroup.PaymentGroupCode':U (icFieldName), 
                input  t_sPaymentGroup.PaymentGroupCode (icFieldValue), 
                input  'E':U (icType), 
                input  3 (iiSeverity), 
                input  t_sPaymentGroup.tc_Rowid (icRowid), 
                input  'QadFin-7974':U (icFcMsgNumber), 
                input  '' (icFcExplanation), 
                input  '' (icFcIdentification), 
                input  '' (icFcContext), 
                output viFcReturnSuper (oiReturnStatus)) in BPaymentGroup>
            
            assign oiReturnStatus = -1.
            return.
        end. /* if vcActivityCode = "Modify":U */

        /* ================================================================= */
        /* When object not found or in create mode, create it.               */
        /* ================================================================= */
        
        <M-4 run AddDetailLine
           (input  'PaymentGroup':U (icTable), 
            input  '' (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BPaymentGroup>        

        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign t_sPaymentGroup.tc_Status = "N":U.
    end. /* if vcActivityCode = "Create":U or */
    else do:
        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign t_sPaymentGroup.tc_Status = "C":U.
    end. /* else do */

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

    /* insert code for subtables here:  */
    <I-56 {UpdateTransString
         &TABLE = "PaymentGroup"}>
             
    /* ================================================================= */
    /* override value for identity fields in input                       */
    /* Update input to allow correct matching                            */
    /* ================================================================= */                
    assign t_sPaymentGroup.PaymentGroup_ID = tPaymentGroup.PaymentGroup_ID
           t_sPaymentGroup.tc_Rowid        = tPaymentGroup.tc_Rowid
           t_sPaymentGroup.tc_ParentRowid  = ""
           opPrimeKey                      = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                                           + string(tPaymentGroup.PaymentGroup_ID).
end. /* for each t_sPaymentGroup on error undo, return: */

if oiReturnStatus = -98
then oiReturnStatus = 0.