project BLF > class BResource > 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/bresource.p)

for each t_sResources on error undo, throw:    

    /* ================================================================= */
    /* When deleting a resource of type 'Menu',                          */
    /* do not delete the resource but delete the menu.                   */
    /* ================================================================= */
    if  vcActivityCode = "Delete":U
    and t_sResources.ResourceType = {&RESOURCE-TYPE-MENU}
    then do:        
        delete t_sResources.
        next.
    end.

    /* ================================================================= */
    /* Lookup resource                                                   */
    /* When in create mode, skip lookup.                                 */
    /* do not return any validation errors                               */
    /* ================================================================= */
    if vcActivityCode <> "Create":U
    then case t_sResources.ResourceType:

        when {&RESOURCE-TYPE-ACTIVITY}
        then do:            

            if t_sResources.tcBusActivityCode = ""
            or t_sResources.tcBusActivityCode = ?
            or t_sResources.tcBusComponentCode = ""
            or t_sResources.tcBusComponentCode = ?
            then do:
                /*should be updated to use activityid, if the componentcode and activitycode 
                  are not available in the input parameter dataset. */
                if t_sResources.BusActivity_ID <> 0 and
                   t_sResources.BusActivity_ID <> ?
                then do:
                    <Q-49 run BusActivityPrim (all) (Read) (NoCache)
                       (input t_sResources.BusActivity_ID, (BusActivityID)
                        input '', (BusActivityCode)
                        input '', (BusComponentCode)
                        output dataset tqBusActivityPrim) in BBusinessComponent >
                    find first tqBusActivityPrim no-error.
                    if available tqBusActivityPrim
                    then do:
                        assign t_sResources.tcBusActivityCode = tqBusActivityPrim.tcBusActivityCode
                               t_sResources.tcBusComponentCode = tqBusActivityPrim.tcBusComponentCode.
                    end.
                    else assign viFcReturnSuper = -4.
                end.
                else assign viFcReturnSuper = -4.
            end. /*viFcReturnSuper = -4.*/

            if t_sResources.tcBusActivityCode = ""
            or t_sResources.tcBusActivityCode = ?
            or t_sResources.tcBusComponentCode = ""
            or t_sResources.tcBusComponentCode = ?
            then assign viFcReturnSuper = -4.
            else do:
                <Q-3 run BusActivityPrim (all)  (Read)  (NoCache)  (input 0, (BusActivityID) 
                          input t_sResources.tcBusActivityCode, (BusActivityCode) 
                          input t_sResources.tcBusComponentCode, (BusComponentCode)
                          output dataset tqBusActivityPrim) in BBusinessComponent >
                find first tqBusActivityPrim no-error.
                if available tqBusActivityPrim
                then do:
                    vcFreeform = "for each Resources where Resources.BusActivity_ID = ":U + string(tqBusActivityPrim.tiBusActivity_ID).
                    <M-4 run DataLoad (input  '' (icRowids), 
                   input  '' (icPkeys), 
                   input  '' (icObjectIds), 
                   input  vcFreeform (icFreeform), 
                   input  yes (ilKeepPrevious), 
                   output viFcReturnSuper (oiReturnStatus)) in BResource>
                    if viFcReturnSuper >= 0
                    then find first tResources where
                                    tResources.BusActivity_ID = tqBusActivityPrim.tiBusActivity_ID no-error.
                end.
                else viFcReturnSuper = -4.
            end.
        end.

        when {&RESOURCE-TYPE-MENU}
        then do:
            if t_sResources.ResourceURI = ""
            or t_sResources.ResourceURI = ?            
            then viFcReturnSuper = -4.
            else do:                                              
                vcFreeform = "for each Resources where Resources.ResourceURI = '":U + t_sResources.ResourceURI + "'":U.
                <M-6 run DataLoad
                   (input  '' (icRowids), 
                    input  '' (icPkeys), 
                    input  '' (icObjectIds), 
                    input  vcFreeform (icFreeform), 
                    input  yes (ilKeepPrevious), 
                    output viFcReturnSuper (oiReturnStatus)) in BResource>
                if viFcReturnSuper >= 0
                then find first tResources where
                                tResources.ResourceURI = t_sResources.ResourceURI no-error.                                
            end.
        end.

        otherwise viFcReturnSuper = -4.

    end case.

    /* ================================================================= */
    /* When in delete mode, ignore input data.                           */
    /* When resource not found, do not return an error.                  */
    /* ================================================================= */
    if vcActivityCode = "Delete":U
    then do:
        if viFcReturnSuper = -4
        then delete t_sResources.
        else do:
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then do:
                <Q-14 run BusActivityPrim  (Stop) in BBusinessComponent >                
                return.
            end.
    
            /* ================================================================= */
            /* Update input to allow correct matching                            */
            /* ================================================================= */
            assign t_sResources.tc_Rowid  = tResources.tc_Rowid
                   t_sResources.tc_ParentRowid = ""
                   opPrimeKey   = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                                + string(tResources.Resource_ID).
        end.

        next.
    end.

    if vcActivityCode = "Create":U
    or viFcReturnSuper = -4
    then do:
        /* ================================================================= */
        /* When resource not found and in modify only mode, return an error. */

        /* ================================================================= */
        if vcActivityCode = "Modify":U
        then do:
            case t_sResources.ResourceType:
                when {&RESOURCE-TYPE-ACTIVITY}
                then vcFreeform = substitute (#T-7'Resource for activity &1 does not exist.':100(6801)T-7#,
                                              t_sResources.tcBusComponentCode + "/":U +
                                              t_sResources.tcBusActivityCode).
                when {&RESOURCE-TYPE-MENU}
                then vcFreeform = substitute (#T-8'Resource for menu $1 does not exist.':100(6799)T-8#,
                                              t_sResources.ResourceURI).
                otherwise
                     vcFreeform = substitute (#T-9'Unknown resource type $1.':100(6800)T-9#,
                                              t_sResources.ResourceType).
            end case.
            <M-10 run SetMessage (input  vcFreeform (icMessage), 
                      input  '' (icArguments), 
                      input  '' (icFieldName), 
                      input  '' (icFieldValue), 
                      input  'E':U (icType), 
                      input  3 (iiSeverity), 
                      input  t_sResources.tc_Rowid (icRowid), 
                      input  'BLF-170':U (icFcMsgNumber), 
                      input  '' (icFcExplanation), 
                      input  '' (icFcIdentification), 
                      input  '' (icFcContext), 
                      output viFcReturnSuper (oiReturnStatus)) in BResource>
            assign oiReturnStatus = -1.
            <Q-16 run BusActivityPrim  (Stop) in BBusinessComponent >            
            return.
        end.

        /* ================================================================= */
        /* When resource not found or in create mode, create it.             */
        /* ================================================================= */
        <M-11 run AddDetailLine (input  'Resources':U (icTable), 
                         input  '' (icParentRowid), 
                         output viFcReturnSuper (oiReturnStatus)) in BResource>

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

    if viFcReturnSuper <> 0
    then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0
    then do:
        <Q-18 run BusActivityPrim  (Stop) in BBusinessComponent >        
        return.
    end.    

    /* ================================================================= */
    /* override value for identity fields in input                       */
    /* ================================================================= */
    assign t_sResources.Resource_ID = tResources.Resource_ID

    /* ================================================================= */
    /* Update input to allow correct matching                            */
    /* ================================================================= */
           t_sResources.tc_Rowid  = tResources.tc_Rowid
           t_sResources.tc_ParentRowid = ""

           opPrimeKey       = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                            + string(tResources.Resource_ID).
end.