project BLF > class BSODPolicyException > 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/bsodpolicyexception.p)

for each t_sSODException by rowid(t_sSODException) on error undo, throw:

    /* ================================================================= */
    /* Lookup object by logical key                                      */
    /* When in create mode, skip lookup.                                 */
    /* ================================================================= */
    if vcActivityCode <> "Create":U
    then do:
        vcFreeform = "for each SODException where SODException.SODExceptionCode = '":U + t_sSODException.SODExceptionCode + "'":U.
        <M-1 run DataLoad
           (input  '' (icRowids), 
            input  '' (icPkeys), 
            input  '' (icObjectIds), 
            input  vcFreeform (icFreeform), 
            input  yes (ilKeepPrevious), 
            output viFcReturnSuper (oiReturnStatus)) in BSODPolicyException>
        if viFcReturnSuper >= 0
        then do:
            /* DataLoad succeeded, no no-error needed */
            find first tSODException where tSODException.SODExceptionCode = t_sSODException.SODExceptionCode.
            if tSODException.tc_Status <> ""
            then do:
                <M-2 run SetMessage
                   (input  #T-11'Duplicate entry in input ($1).':255(332074471)T-11# (icMessage), 
                    input  t_sSODException.SODExceptionCode (icArguments), 
                    input  'tSODException.SODExceptionCode' (icFieldName), 
                    input  t_sSODException.SODExceptionCode (icFieldValue), 
                    input  'E' (icType), 
                    input  3 (iiSeverity), 
                    input  t_sSODException.tc_Rowid (icRowid), 
                    input  'BLF-251':U (icFcMsgNumber), 
                    input  '' (icFcExplanation), 
                    input  '' (icFcIdentification), 
                    input  '' (icFcContext), 
                    output viFcReturnSuper (oiReturnStatus)) in BSODPolicyException>
                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_sSODException.
        else do:
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then return.
    
            /* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
            create tFcRowidConvert.
            assign tFcRowidConvert.tcFcOldRowid = t_sSODException.tc_Rowid
                   tFcRowidConvert.tcFcNewRowid = tSODException.tc_Rowid
                   tFcRowidConvert.tlFcOk       = true.

            /* ================================================================= */
            /* Update input to allow correct matching                            */
            /* ================================================================= */
            assign t_sSODException.tc_Rowid  = tSODException.tc_Rowid
                   t_sSODException.tc_ParentRowid = ""
                   opPrimeKey   = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                                + string(tSODException.SODException_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:
            <M-3 run SetMessage
               (input  #T-2'Policy exception with code ($1) does not exist.':255(73479516)T-2# (icMessage), 
                input  t_sSODException.SODExceptionCode (icArguments), 
                input  'tSODException.SODExceptionCode' (icFieldName), 
                input  t_sSODException.SODExceptionCode (icFieldValue), 
                input  'E' (icType), 
                input  3 (iiSeverity), 
                input  t_sSODException.tc_Rowid (icRowid), 
                input  'BLF-252':U (icFcMsgNumber), 
                input  '' (icFcExplanation), 
                input  '' (icFcIdentification), 
                input  '' (icFcContext), 
                output viFcReturnSuper (oiReturnStatus)) in BSODPolicyException>
            assign oiReturnStatus = -1.
            return.
        end.

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

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

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

    /* ================================================================= */
    /* Delete existing detail                                            */
    /* ================================================================= */
    for each tSODExceptionLn where
             tSODExceptionLn.tc_ParentRowid = tSODException.tc_Rowid on error undo, throw:
        assign tSODExceptionLn.tc_Status = "D":U.
    end.
    
    /* ================================================================= */
    /* Update / add detail                                               */
    /* ================================================================= */
    for each t_sSODExceptionLn where
             t_sSODExceptionLn.tc_ParentRowid = t_sSODException.tc_Rowid on error undo, throw:
    
        find first tSODExceptionLn where
                   tSODExceptionLn.tc_ParentRowid = tSODException.tc_Rowid and
                   tSODExceptionLn.tcDomainCode  = t_sSODExceptionLn.tcDomainCode and
                   tSODExceptionLn.tcCompanyCode  = t_sSODExceptionLn.tcCompanyCode and
                   tSODExceptionLn.tcSODCategory1Code  = t_sSODExceptionLn.tcSODCategory1Code and
                   tSODExceptionLn.tcSODCategory2Code  = t_sSODExceptionLn.tcSODCategory2Code no-error.
        if available tSODExceptionLn
        then if tSODExceptionLn.tc_Status = "D":U
        then assign t_sSODExceptionLn.tc_Status = "C":U
                      tSODExceptionLn.tc_Status = "C":U.
        else do:
            vcKey = (if t_sSODExceptionLn.tcDomainCode = ""
                     or t_sSODExceptionLn.tcDomainCode = ?
                     then ""
                     else #T-6'Domain':20(8454)T-6# + " = " + t_sSODExceptionLn.tcDomainCode)
                  + (if t_sSODExceptionLn.tcCompanyCode = ""
                     or t_sSODExceptionLn.tcCompanyCode = ?
                     then ""
                     else ", " + #T-7'Entity':15(8455)T-7# + " = " + t_sSODExceptionLn.tcCompanyCode)
                  + (if t_sSODExceptionLn.tcSODCategory1Code = ""
                     or t_sSODExceptionLn.tcSODCategory1Code = ?
                     then ""
                     else ", " + #T-8'SOD Category 1':20(356540589)T-8# + " = " + t_sSODExceptionLn.tcSODCategory1Code)
                  + (if t_sSODExceptionLn.tcSODCategory2Code = ""
                     or t_sSODExceptionLn.tcSODCategory2Code = ?
                     then ""
                     else ", " + #T-9'SOD Category 2':20(957894087)T-9# + " = " + t_sSODExceptionLn.tcSODCategory2Code).
            <M-10 run SetMessage
               (input  #T-10'Duplicate entry in input ($1).':255(332074471)T-10# (icMessage), 
                input  vcKey (icArguments), 
                input  'tSODExceptionLn.tcSODCategory2Code' (icFieldName), 
                input  t_sSODExceptionLn.tcSODCategory2Code (icFieldValue), 
                input  'E' (icType), 
                input  3 (iiSeverity), 
                input  t_sSODExceptionLn.tc_Rowid (icRowid), 
                input  'BLF-253':U (icFcMsgNumber), 
                input  '' (icFcExplanation), 
                input  '' (icFcIdentification), 
                input  '' (icFcContext), 
                output viFcReturnSuper (oiReturnStatus)) in BSODPolicyException>
            assign oiReturnStatus = -1.
            return.
        end.
        else do:
            <M-5 run AddDetailLine
               (input  'SODExceptionLn' (icTable), 
                input  tSODException.tc_Rowid (icParentRowid), 
                output viFcReturnSuper (oiReturnStatus)) in BSODPolicyException>
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then return.
            assign t_sSODExceptionLn.tc_Status         = "N":U
                   tSODExceptionLn.tcDomainCode        = t_sSODExceptionLn.tcDomainCode
                   tSODExceptionLn.tcCompanyCode       = t_sSODExceptionLn.tcCompanyCode
                   tSODExceptionLn.tcSODCategory1Code  = t_sSODExceptionLn.tcSODCategory1Code
                   tSODExceptionLn.tcSODCategory2Code  = t_sSODExceptionLn.tcSODCategory2Code.
        end.
    
        /* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
        create tFcRowidConvert.
        assign tFcRowidConvert.tcFcOldRowid = t_sSODExceptionLn.tc_Rowid
               tFcRowidConvert.tcFcNewRowid = tSODExceptionLn.tc_Rowid
               tFcRowidConvert.tlFcOk       = true.
    
        /* ================================================================= */
        /* override value for identity fields in input                       */
        /* ================================================================= */
        assign t_sSODExceptionLn.SODExceptionLn_ID = tSODExceptionLn.SODExceptionLn_ID
    
        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
               t_sSODExceptionLn.SODException_ID = tSODExceptionLn.SODException_ID
               t_sSODExceptionLn.tc_Rowid       = tSODExceptionLn.tc_Rowid
               t_sSODExceptionLn.tc_ParentRowid = tSODException.tc_Rowid.
    end.
    
    <I-19 {UpdateTransString
         &TABLE = "SODException"}>
         
    /* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
    create tFcRowidConvert.
    assign tFcRowidConvert.tcFcOldRowid = t_sSODException.tc_Rowid
           tFcRowidConvert.tcFcNewRowid = tSODException.tc_Rowid
           tFcRowidConvert.tlFcOk       = true.

    /* ================================================================= */
    /* override value for identity fields in input                       */
    /* ================================================================= */
    assign t_sSODException.SODException_ID = tSODException.SODException_ID

    /* ================================================================= */
    /* Update input to allow correct matching                            */
    /* ================================================================= */
           t_sSODException.tc_Rowid  = tSODException.tc_Rowid
           t_sSODException.tc_ParentRowid = ""

           opPrimeKey       = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                            + string(tSODException.SODException_ID).
end.