project BLF > class BUser > 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/buser.p)

for each t_sUsr on error undo, throw:

    /* ================================================================= */
    /* Lookup user by login ID                                           */
    /* When in create mode, skip lookup.                                 */
    /* ================================================================= */
    if vcActivityCode <> "Create":U
    then do:
        vcFreeform = "for each Usr where Usr.UsrLogin = '":U + t_sUsr.UsrLogin + "'":U.
        <M-8 run DataLoad (input  '' (icRowids), 
                   input  '' (icPkeys), 
                   input  '' (icObjectIds), 
                   input  vcFreeform (icFreeform), 
                   input  yes (ilKeepPrevious), 
                   output viFcReturnSuper (oiReturnStatus)) in BUser>
        if viFcReturnSuper >= 0
        then find tUsr where tUsr.UsrLogin = t_sUsr.UsrLogin no-error.
    end.

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

        next.
    end.

    if vcActivityCode = "Create":U
    or viFcReturnSuper = -4
    then do:
        /* ================================================================= */
        /* When user not found and in modify only mode, return an error.     */
        /* ================================================================= */
        if vcActivityCode = "Modify":U
        then do:
            <M-11 run SetMessage (input  #T-1'User with login $1 does not exist.':100(6797)T-1# (icMessage), 
                      input  t_sUsr.UsrLogin (icArguments), 
                      input  'tUsr.UsrLogin':U (icFieldName), 
                      input  t_sUsr.UsrLogin (icFieldValue), 
                      input  'E':U (icType), 
                      input  3 (iiSeverity), 
                      input  t_sUsr.tc_Rowid (icRowid), 
                      input  'BLF-235':U (icFcMsgNumber), 
                      input  '' (icFcExplanation), 
                      input  '' (icFcIdentification), 
                      input  '' (icFcContext), 
                      output viFcReturnSuper (oiReturnStatus)) in BUser>
            assign oiReturnStatus = -1.
            return.
        end.

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

        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign t_sUsr.tc_Status = "N":U.
    end.
    else do:
        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
        assign t_sUsr.tc_Status = "C":U.
    end.

    if viFcReturnSuper <> 0
    then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0
    then return.
  
    /* #351 When Mfg is replication users to financials, they will not pass any usrcompany or usrdomain records.
     * But these records may not be deleted.
     * This is not standard behavior anymore.
     * We will first copy the tUsrCompany and tUsrDomain records to the t_sUsrCompany and t_sUsrDomain tables
     */   
    if not can-find (first t_sUsrCompany where t_sUsrCompany.tc_ParentRowid = t_sUsr.tc_Rowid)
    then
    for each tUsrCompany where
             tUsrCompany.tc_ParentRowid = tUsr.tc_Rowid on error undo, throw:
        Create t_sUsrCompany.
        Buffer-copy tUsrCompany To t_sUsrCompany.
        Assign t_sUsrCompany.tc_ParentRowid = t_sUsr.tc_Rowid.
    end.
    
    if not can-find (first t_sUsrDomain where t_sUsrDomain.tc_ParentRowid = t_sUsr.tc_Rowid)
    then
    for each tUsrDomain where
             tUsrDomain.tc_ParentRowid = tUsr.tc_Rowid on error undo, throw:
        Create t_sUsrDomain.
        Buffer-copy tUsrDomain To t_sUsrDomain.
        Assign t_sUsrDomain.tc_ParentRowid = t_sUsr.tc_Rowid.
    end.
                                                                            
    /* ================================================================= */
    /* Update company links : delete existing links                      */
    /* ================================================================= */
    for each tUsrCompany where
             tUsrCompany.tc_ParentRowid = tUsr.tc_Rowid on error undo, throw:
        assign tUsrCompany.tc_Status = "D":U.
    end.

    /* ================================================================= */
    /* Update company links : add new links                              */
    /* ================================================================= */
    for each t_sUsrCompany where
             t_sUsrCompany.tc_ParentRowid = t_sUsr.tc_Rowid on error undo, throw:

        find first tUsrCompany where
                   tUsrCompany.tc_ParentRowid = tUsr.tc_Rowid and
                   tUsrCompany.tcCompanyCode  = t_sUsrCompany.tcCompanyCode no-error.
        if available tUsrCompany
        then assign t_sUsrCompany.tc_Status = "C":U.
        else do:
            <M-5 run AddDetailLine (input  'UsrCompany':U (icTable), 
                    input  tUsr.tc_Rowid (icParentRowid), 
                    output viFcReturnSuper (oiReturnStatus)) in BUser>
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then return.
            assign t_sUsrCompany.tc_Status = "N":U.
        end.

        /* ================================================================= */
        /* override value for identity fields in input                       */
        /* ================================================================= */
        assign t_sUsrCompany.UsrCompany_ID  = tUsrCompany.UsrCompany_ID

        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
               t_sUsrCompany.Usr_ID         = tUsr.Usr_ID
               t_sUsrCompany.tc_Rowid       = tUsrCompany.tc_Rowid
               t_sUsrCompany.tc_ParentRowid = tUsr.tc_Rowid.
    end.
     
    /* ================================================================= */
    /* Update domain links : delete existing links                      */
    /* ================================================================= */    
    for each tUsrDomain where
             tUsrDomain.tc_ParentRowid = tUsr.tc_Rowid on error undo, throw:
        assign tUsrDomain.tc_Status = "D":U.
    end.    

    /* ================================================================= */
    /* Update domain links : add new links                              */
    /* ================================================================= */
    for each t_sUsrDomain where
             t_sUsrDomain.tc_ParentRowid = t_sUsr.tc_Rowid on error undo, throw:

        find first tUsrDomain where
                   tUsrDomain.tc_ParentRowid = tUsr.tc_Rowid and
                   tUsrDomain.tcDomainCode   = t_sUsrDomain.tcDomainCode no-error.
        if available tUsrDomain
        then assign t_sUsrDomain.tc_Status = "C":U.
        else do:
            <M-10 run AddDetailLine (input  'UsrDomain':U (icTable), 
                     input  tUsr.tc_Rowid (icParentRowid), 
                     output viFcReturnSuper (oiReturnStatus)) in BUser>
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then return.
            assign t_sUsrDomain.tc_Status = "N":U.
        end.

        /* ================================================================= */
        /* override value for identity fields in input                       */
        /* ================================================================= */
        assign t_sUsrDomain.UsrDomain_ID  = tUsrDomain.UsrDomain_ID

        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
               t_sUsrDomain.Usr_ID         = tUsr.Usr_ID
               t_sUsrDomain.tc_Rowid       = tUsrDomain.tc_Rowid
               t_sUsrDomain.tc_ParentRowid = tUsr.tc_Rowid.
    end.

    /* ================================================================= */
    /* override value for identity fields in input                       */
    /* ================================================================= */
    assign t_sUsr.Usr_ID    = tUsr.Usr_ID

    /* ================================================================= */
    /* Update input to allow correct matching                            */
    /* ================================================================= */
           t_sUsr.tc_Rowid  = tUsr.tc_Rowid
           t_sUsr.tc_ParentRowid = ""

           opPrimeKey       = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                            + string(tUsr.Usr_ID).
end.