project QadFinancials > class BBankPayFormat > 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/bbankpayformat.p)

if oiReturnStatus = 0
then oiReturnStatus = -98.

/* ========================= */
/* Start Queries             */
/* ========================= */
<Q-26 run BankNumberPrim  (Start) in BBankNumber >
<Q-11 run CreditorPrim (Start) in BCreditor >
<Q-12 run DebtorPrim (Start) in BDebtor >
<Q-13 run EmployeePrim (Start) in BEmployee >
<Q-14 run GLPrim (Start) in BGL >

for each t_sbankpayformat on error undo, return:
    /* ======================================================= */
    /* Find banknumber_id required for record creation         */
    /* ======================================================= */
    case t_sBankPayFormat.tcParentType:
        when {&BANKNUMBERPARENTTYPE-CREDITOR}
        then do:
            <Q-5 run CreditorPrim (all) (Read) (Cache)
               (input viCompanyId, (CompanyId)
                input ?, (CreditorId)
                input t_sBankPayFormat.tcParentCode, (CreditorCode)
                output dataset tqCreditorPrim) in BCreditor >
            find first tqCreditorPrim no-error.
            if available tqCreditorPrim
            then assign t_sbankpayformat.tiParentObject_ID = tqCreditorPrim.tiCreditor_ID. 
            else assign t_sbankpayformat.tiParentObject_ID = ?. 
        end. /* Creditor */
        when {&BANKNUMBERPARENTTYPE-DEBTOR}
        then do:
            <Q-6 run DebtorPrim (all) (Read) (Cache)
               (input viCompanyId, (CompanyId)
                input t_sbankpayformat.tcParentCode, (DebtorCode)
                input ?, (Debtor_ID)
                output dataset tqDebtorPrim) in BDebtor >
            find first tqDebtorPrim no-error.
            if available tqDebtorPrim
            then assign t_sbankpayformat.tiParentObject_ID = tqDebtorPrim.tiDebtor_ID. 
            else assign t_sbankpayformat.tiParentObject_ID = ?.
        end. /* Debtor */
        when {&BANKNUMBERPARENTTYPE-EMPLOYEE}
        then do:    
            <Q-7 run EmployeePrim (all) (Read) (Cache)
               (input ?, (EmployeeId)
                input t_sBankPayFormat.tcParentCode, (EmployeeCode)
                input viCompanyId, (CompanyId)
                output dataset tqEmployeePrim) in BEmployee >
            find first tqEmployeePrim no-error.
            if available tqEmployeePrim
            then assign t_sbankpayformat.tiParentObject_ID = tqEmployeePrim.tiEmployee_ID. 
            else assign t_sbankpayformat.tiParentObject_ID = ?.
        end. /* Employee */
        when {&BANKNUMBERPARENTTYPE-GL}
        then do:
            <Q-8 run GLPrim (all) (Read) (Cache)
               (input viCompanyId, (CompanyId)
                input t_sBankPayFormat.tcParentCode, (GLCode)
                input ?, (GLId)
                output dataset tqGLPrim) in BGL >
            find first tqGLPrim no-error.
            if available tqGLPrim
            then assign t_sbankpayformat.tiParentObject_ID = tqGLPrim.tiGL_ID. 
            else assign t_sbankpayformat.tiParentObject_ID = ?.
        end. /* G/L */
        otherwise assign t_sbankpayformat.tiParentObject_ID = ?.
    end case.

    /* =============================================== */
    /* Try to convert the logical key into the real ID */
    /* =============================================== */
    if t_sbankpayformat.tiParentObject_ID <> ?      and 
       t_sbankpayformat.tiParentObject_ID <> 0 
    then do :
        
        <Q-9 run BankNumberPrim (all) (Read) (NoCache)
           (input ?, (BankNumberId)
            input t_sBankPayFormat.tiParentObject_ID, (ParentObjectId)
            input t_sBankPayFormat.tcBankNumber, (BankNumber)
            input t_sBankPayFormat.tcBankNumberExtension, (BankNumberExtension)
            input ?, (BankPayFormatID)
            output dataset tqBankNumberPrim) in BBankNumber >
        find tqBankNumberPrim where 
            tqBankNumberPrim.tiParentObject_ID     = t_sbankpayformat.tiParentObject_ID and 
            tqBankNumberPrim.tcBankNumber          = t_sbankpayformat.tcBankNumber      and 
            tqBankNumberPrim.tcBankNumberExtension = t_sbankpayformat.tcBankNumberExtension 
            /* BKW: Add search on BankPayFormat_ID */
            and tqBankNumberPrim.tiBankPayFormat_ID = t_sbankpayformat.BankPayFormat_ID
            no-lock no-error.
        if available tqBankNumberPrim
        then assign t_sbankpayformat.BankNumber_ID = tqBankNumberPrim.tiBankNumber_ID. 
        

    end. /* if t_sbankpayformat.ParentObject <> ?   and */
   
    if t_sbankpayformat.BankNumber_ID = ? or
       t_sbankpayformat.BankNumber_ID = 0
    then do:
        assign
            vcMessage1 = trim(#T-22'The specified bank number ID is not defined in the system.':100(65408)t-22#).
        <M-21 run SetMessage
           (input  vcMessage1 (icMessage), 
            input  t_sBankPayFormat.BankPayFormat_ID (icArguments), 
            input  't_sBankPayFormat.BankPayFormat_ID' (icFieldName), 
            input  t_sBankPayFormat.BankPayFormat_ID (icFieldValue), 
            input  'E' (icType), 
            input  3 (iiSeverity), 
            input  t_sBankPayFormat.tc_Rowid (icRowid), 
            input  'QadFin-7027':U (icFcMsgNumber), 
            input  '' (icFcExplanation), 
            input  '' (icFcIdentification), 
            input  '' (icFcContext), 
            output viFcReturnSuper (oiReturnStatus)) in BBankPayFormat>
            assign oiReturnStatus = -1.
            return.
    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
                vcMessage1 = trim(#T-2'Object with key $1 does not exist.':100(48021)T-2#).
            <M-4 run SetMessage
               (input  vcMessage1 (icMessage), 
                input  t_sBankPayFormat.BankPayFormat_ID (icArguments), 
                input  't_sBankPayFormat.BankPayFormat_ID' (icFieldName), 
                input  t_sBankPayFormat.BankPayFormat_ID (icFieldValue), 
                input  'E' (icType), 
                input  3 (iiSeverity), 
                input  t_sBankPayFormat.tc_Rowid (icRowid), 
                input  'QadFin-7026':U (icFcMsgNumber), 
                input  '' (icFcExplanation), 
                input  '' (icFcIdentification), 
                input  '' (icFcContext), 
                output viFcReturnSuper (oiReturnStatus)) in BBankPayFormat>
            
            assign oiReturnStatus = -1.
            return.
        end.  /* if vcActivityCode = Modify */

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

        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign 
            t_sbankpayformat.tc_Status = "N":U.
    end.  /* if vcActivityCode = Create */
    else do:
        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign 
            t_sbankpayformat.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_sbankpayformat.bankpayformat_id = tbankpayformat.bankpayformat_id

        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        t_sbankpayformat.tc_Rowid       = tbankpayformat.tc_Rowid
        t_sbankpayformat.tc_ParentRowid = ""

        opPrimeKey       = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                         + string(tbankpayformat.bankpayformat_id).
end.

/* ========================= */
/* Stop Queries             */
/* ========================= */
<Q-27 run BankNumberPrim  (Stop) in BBankNumber >
<Q-17 run CreditorPrim  (Stop) in BCreditor >
<Q-18 run DebtorPrim  (Stop) in BDebtor >
<Q-19 run EmployeePrim  (Stop) in BEmployee >
<Q-20 run GLPrim  (Stop) in BGL >

if oiReturnStatus = -98
then oiReturnStatus = 0.