project BLF > class BCustomField > 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/bcustomfield.p)

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

    if t_sCustomField.tcLookupType = ?
    then t_sCustomField.tcLookupType = "".
    
    if t_sCustomField.CustomFieldComponent = ""
    or t_sCustomField.CustomFieldComponent = ?
    then do:
        <M-54 run SetMessage
           (input  #T-69'Component name is mandatory.':255(788911950)T-69# (icMessage), 
            input  '' (icArguments), 
            input  'tCustomField.CustomFieldComponent' (icFieldName), 
            input  t_sCustomField.CustomFieldComponent (icFieldValue), 
            input  'E' (icType), 
            input  3 (iiSeverity), 
            input  t_sCustomField.tc_Rowid (icRowid), 
            input  'blf-505405':U (icFcMsgNumber), 
            input  '' (icFcExplanation), 
            input  '' (icFcIdentification), 
            input  '' (icFcContext), 
            output viFcReturnSuper (oiReturnStatus)) in BCustomField>
        assign oiReturnStatus = -1.
        return.
    end.
    
    if t_sCustomField.CustomFieldFieldName = ""
    or t_sCustomField.CustomFieldFieldName = ?
    then do:
        <M-68 run SetMessage
           (input  #T-48'Field name is mandatory.':255(322934822)T-48# (icMessage), 
            input  '' (icArguments), 
            input  'tCustomField.CustomFieldFieldName' (icFieldName), 
            input  t_sCustomField.CustomFieldFieldName (icFieldValue), 
            input  'E' (icType), 
            input  3 (iiSeverity), 
            input  t_sCustomField.tc_Rowid (icRowid), 
            input  'blf-336564':U (icFcMsgNumber), 
            input  '' (icFcExplanation), 
            input  '' (icFcIdentification), 
            input  '' (icFcContext), 
            output viFcReturnSuper (oiReturnStatus)) in BCustomField>
        assign oiReturnStatus = -1.
        return.
    end.
    
    /* ================================================================= */
    /* Lookup object by logical key                                      */
    /* When in create mode, skip lookup.                                 */
    /* ================================================================= */
    if vcActivityCode <> "Create":U
    then do:
        vcFreeform = "for each CustomField where "
                   + "CustomField.CustomFieldComponent = '":U + t_sCustomField.CustomFieldComponent + "' and "
                   + "CustomField.CustomFieldFieldName = '":U + t_sCustomField.CustomFieldFieldName + "'":U.
        <M-34 run DataLoad
           (input  '' (icRowids), 
            input  '' (icPkeys), 
            input  '' (icObjectIds), 
            input  vcFreeform (icFreeform), 
            input  yes (ilKeepPrevious), 
            output viFcReturnSuper (oiReturnStatus)) in BCustomField>
        if viFcReturnSuper >= 0
        then do:
            /* DataLoad succeeded, no no-error needed */
            find first tCustomField where
                       tCustomField.CustomFieldComponent = t_sCustomField.CustomFieldComponent and
                       tCustomField.CustomFieldFieldName = t_sCustomField.CustomFieldFieldName.
            if tCustomField.tc_Status <> ""
            then do:
                <M-84 run SetMessage
                   (input  #T-22'Duplicate entry in input ($1).':255(332074471)T-22# (icMessage), 
                    input  t_sCustomField.CustomFieldComponent + '/' + t_sCustomField.CustomFieldFieldName (icArguments), 
                    input  'tCustomField.CustomFieldFieldName' (icFieldName), 
                    input  t_sCustomField.CustomFieldFieldName (icFieldValue), 
                    input  'E' (icType), 
                    input  3 (iiSeverity), 
                    input  t_sCustomField.tc_Rowid (icRowid), 
                    input  'blf-680195':U (icFcMsgNumber), 
                    input  '' (icFcExplanation), 
                    input  '' (icFcIdentification), 
                    input  '' (icFcContext), 
                    output viFcReturnSuper (oiReturnStatus)) in BCustomField>
                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_sCustomField.
        else do:
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then return.

            /* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
            <M-89 run SetRowidConvert
               (input  t_sCustomField.tc_Rowid (icOldRowid), 
                input  tCustomField.tc_Rowid (icNewRowid), 
                output viFcReturnSuper (oiReturnStatus)) in BCustomField>

            /* ================================================================= */
            /* Update input to allow correct matching                            */
            /* ================================================================= */
            assign t_sCustomField.tc_Rowid  = tCustomField.tc_Rowid
                   t_sCustomField.tc_ParentRowid = ""
                   opPrimeKey   = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                                + string(tCustomField.CustomField_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-17 run SetMessage
               (input  #T-1'This custom field ($1) does not exist.':255(661239297)T-1# (icMessage), 
                input  t_sCustomField.CustomFieldComponent + '/' + t_sCustomField.CustomFieldFieldName (icArguments), 
                input  'tCustomField.CustomFieldFieldName' (icFieldName), 
                input  t_sCustomField.CustomFieldFieldName (icFieldValue), 
                input  'E' (icType), 
                input  3 (iiSeverity), 
                input  t_sCustomField.tc_Rowid (icRowid), 
                input  'blf-831869':U (icFcMsgNumber), 
                input  '' (icFcExplanation), 
                input  '' (icFcIdentification), 
                input  '' (icFcContext), 
                output viFcReturnSuper (oiReturnStatus)) in BCustomField>
            assign oiReturnStatus = -1.
            return.
        end.

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

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

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

    /* ================================================================= */
    /* Delete existing detail                                            */
    /* ================================================================= */
    for each tCustomValue where
             tCustomValue.tc_ParentRowid = tCustomField.tc_Rowid:
        assign tCustomValue.tc_Status = "D":U.
    end.
    
    /* ================================================================= */
    /* Update / add detail                                               */
    /* ================================================================= */
    for each t_sCustomValue where
             t_sCustomValue.tc_ParentRowid = t_sCustomField.tc_Rowid:
    
        find first tCustomValue where
                   tCustomValue.tc_ParentRowid = tCustomField.tc_Rowid and
                   tCustomValue.CustomValueCode  = t_sCustomValue.CustomValueCode no-error.
        if available tCustomValue
        then if tCustomValue.tc_Status = "D":U
        then assign t_sCustomValue.tc_Status = "C":U
                      tCustomValue.tc_Status = "C":U.
        else do:
             <M-76 run SetMessage
                (input  #T-57'Duplicate entry in input ($1).':255(332074471)T-57# (icMessage), 
                 input  t_sCustomValue.CustomValueCode (icArguments), 
                 input  'tCustomValue.CustomValueCode' (icFieldName), 
                 input  t_sCustomValue.CustomValueCode (icFieldValue), 
                 input  'E' (icType), 
                 input  3 (iiSeverity), 
                 input  t_sCustomValue.tc_Rowid (icRowid), 
                 input  'blf-189690':U (icFcMsgNumber), 
                 input  '' (icFcExplanation), 
                 input  '' (icFcIdentification), 
                 input  '' (icFcContext), 
                 output viFcReturnSuper (oiReturnStatus)) in BCustomField>
            assign oiReturnStatus = -1.
            return.
        end.
        else do:
            <M-87 run AddDetailLine
               (input  'CustomValue' (icTable), 
                input  tCustomField.tc_Rowid (icParentRowid), 
                output viFcReturnSuper (oiReturnStatus)) in BCustomField>
            if viFcReturnSuper <> 0
            then oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0
            then return.
            assign t_sCustomValue.tc_Status = "N":U
                   tCustomValue.CustomValueCode  = t_sCustomValue.CustomValueCode.
        end.
    
        /* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
        <M-24 run SetRowidConvert
           (input  t_sCustomValue.tc_Rowid (icOldRowid), 
            input  tCustomValue.tc_Rowid (icNewRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BCustomField>
    
        /* ================================================================= */
        /* override value for identity fields in input                       */
        /* ================================================================= */
        assign t_sCustomValue.CustomValue_ID = tCustomValue.CustomValue_ID
    
        /* ================================================================= */
        /* Update input to allow correct matching                            */
        /* ================================================================= */
               t_sCustomValue.CustomField_ID = tCustomValue.CustomField_ID
               t_sCustomValue.tc_Rowid       = tCustomValue.tc_Rowid
               t_sCustomValue.tc_ParentRowid = tCustomField.tc_Rowid.
    end.
    
    <I-8 {UpdateTransString
         &TABLE = "CustomField"}>
         
    /* keep the UI rowid for usage in error messages (tFcMessages.tcFcRowid) */
    <M-74 run SetRowidConvert
       (input  t_sCustomField.tc_Rowid (icOldRowid), 
        input  tCustomField.tc_Rowid (icNewRowid), 
        output viFcReturnSuper (oiReturnStatus)) in BCustomField>

    /* ================================================================= */
    /* override value for identity fields in input                       */
    /* ================================================================= */
    assign t_sCustomField.CustomField_ID = tCustomField.CustomField_ID

    /* ================================================================= */
    /* Update input to allow correct matching                            */
    /* ================================================================= */
           t_sCustomField.tc_Rowid  = tCustomField.tc_Rowid
           t_sCustomField.tc_ParentRowid = ""

           opPrimeKey       = (if opPrimeKey = "" then "" else opPrimeKey + chr(4))
                            + string(tCustomField.CustomField_ID).
end.