project BLF > class BReportRequest > 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/breportrequest.p)

vcLDate = <M-7 DisplayDate  (input  ? (itDate)) in BReportRequest>.
vcLNum  = <M-10 DisplayDecimal
             (input  ? (idDecimal), 
              input  '' (icFormat)) in BReportRequest>.

for each t_sRptRequest on error undo, throw:

    assign t_sRptRequest.RptRequestType = "R".

    if t_sRptRequest.RptRequestDateFormat = ""
    or t_sRptRequest.RptRequestDateFormat = ?
    then t_sRptRequest.RptRequestDateFormat = lc(substring(vcLDate,1,3,"character")).
    
    if t_sRptRequest.RptRequestDateSeparator = ""
    or t_sRptRequest.RptRequestDateSeparator = ?
    then t_sRptRequest.RptRequestDateSeparator = (if length(vcLDate,"character") < 4
                                                  then "/"
                                                  else substring(vcLDate,4,1,"character")).
    
    if t_sRptRequest.RptRequestDecimalPoint = ""
    or t_sRptRequest.RptRequestDecimalPoint = ?
    then t_sRptRequest.RptRequestDecimalPoint = (if vcLNum = "american"
                                                 then "."
                                                 else if vcLNum = "european"
                                                      then ","
                                                      else vcLNum).

    /* Requests = no update, only create */
    <M-3 run AddDetailLine
       (input  'RptRequest' (icTable), 
        input  '' (icParentRowid), 
        output viFcReturnSuper (oiReturnStatus)) in BReportRequest>

    if viFcReturnSuper <> 0
    then assign oiReturnStatus = viFcReturnSuper.

    if viFcReturnSuper < 0
    then return.

    /* Should be available */
    find tRptRequest where
         tRptRequest.tc_Rowid = vcLastCreatedRowid
         no-error.

    /* Add detail */
    for each t_sRptRequestCBF where
             t_sRptRequestCBF.tc_ParentRowid = t_sRptRequest.tc_Rowid on error undo, throw:
        <M-4 run AddDetailLine
           (input  'RptRequestCBF' (icTable), 
            input  tRptRequest.tc_Rowid (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BReportRequest>

        if viFcReturnSuper <> 0
        then assign oiReturnStatus = viFcReturnSuper.

        if viFcReturnSuper < 0
        then return.

        /* Should be available */
        find tRptRequestCBF where
             tRptRequestCBF.tc_Rowid = vcLastCreatedRowid
             no-error.

        assign t_sRptRequestCBF.tc_Status        = "N"
               t_sRptRequestCBF.RptRequestCBF_ID = tRptRequestCBF.RptRequestCBF_ID
               t_sRptRequestCBF.RptRequest_ID    = tRptRequestCBF.RptRequest_ID
               t_sRptRequestCBF.tc_Rowid         = tRptRequestCBF.tc_Rowid
               t_sRptRequestCBF.tc_ParentRowid   = tRptRequest.tc_Rowid.
    end.

    /* Add detail */
    for each t_sRptRequestFilter where
             t_sRptRequestFilter.tc_ParentRowid = t_sRptRequest.tc_Rowid on error undo, throw:
        <M-5 run AddDetailLine
           (input  'RptRequestFilter' (icTable), 
            input  tRptRequest.tc_Rowid (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BReportRequest>

        if viFcReturnSuper <> 0
        then assign oiReturnStatus = viFcReturnSuper.

        if viFcReturnSuper < 0
        then return.

        /* Should be available */
        find tRptRequestFilter where
             tRptRequestFilter.tc_Rowid = vcLastCreatedRowid
             no-error.

        assign t_sRptRequestFilter.tc_Status           = "N"
               t_sRptRequestFilter.RptRequestFilter_ID = tRptRequestFilter.RptRequestFilter_ID
               t_sRptRequestFilter.RptRequest_ID       = tRptRequestFilter.RptRequest_ID
               t_sRptRequestFilter.tc_Rowid            = tRptRequestFilter.tc_Rowid
               t_sRptRequestFilter.tc_ParentRowid      = tRptRequest.tc_Rowid.
    end.

    /* Add detail */
    for each t_sRptRequestMail where
             t_sRptRequestMail.tc_ParentRowid = t_sRptRequest.tc_Rowid on error undo, throw:
        <M-6 run AddDetailLine
           (input  'RptRequestMail' (icTable), 
            input  tRptRequest.tc_Rowid (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BReportRequest>

        if viFcReturnSuper <> 0
        then assign oiReturnStatus = viFcReturnSuper.

        if viFcReturnSuper < 0
        then return.

        /* Should be available */
        find tRptRequestMail where
             tRptRequestMail.tc_Rowid = vcLastCreatedRowid
             no-error.

        assign t_sRptRequestMail.tc_Status         = "N"
               t_sRptRequestMail.RptRequestMail_ID = tRptRequestMail.RptRequestMail_ID
               t_sRptRequestMail.RptRequest_ID     = tRptRequestMail.RptRequest_ID
               t_sRptRequestMail.tc_Rowid          = tRptRequestMail.tc_Rowid
               t_sRptRequestMail.tc_ParentRowid    = tRptRequest.tc_Rowid.
    end.

    /* Add detail */
    for each t_sRptRequestContext where
             t_sRptRequestContext.tc_ParentRowid = t_sRptRequest.tc_Rowid on error undo, throw:
        <M-1 run AddDetailLine
           (input  'RptRequestContext' (icTable), 
            input  tRptRequest.tc_Rowid (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BReportRequest>

        if viFcReturnSuper <> 0
        then assign oiReturnStatus = viFcReturnSuper.

        if viFcReturnSuper < 0
        then return.

        /* Should be available */
        find tRptRequestContext where
             tRptRequestContext.tc_Rowid = vcLastCreatedRowid
             no-error.

        assign t_sRptRequestContext.tc_Status            = "N"
               t_sRptRequestContext.RptRequestContext_ID = tRptRequestContext.RptRequestContext_ID
               t_sRptRequestContext.RptRequest_ID        = tRptRequestContext.RptRequest_ID
               t_sRptRequestContext.tc_Rowid             = tRptRequestContext.tc_Rowid
               t_sRptRequestContext.tc_ParentRowid       = tRptRequest.tc_Rowid.
    end.

    for each t_sReportSchedule where
             t_sReportSchedule.tc_Rowid = t_sRptRequest.tc_Rowid on error undo, throw:
        assign t_sReportSchedule.tc_Rowid  = tRptRequest.tc_Rowid
               t_sReportSchedule.tc_Status = "N".
    end.

    if opPrimeKey <> ""
    then assign opPrimeKey = opPrimeKey + chr(4).

    assign t_sRptRequest.tc_Status      = "N"
           t_sRptRequest.RptRequest_ID  = tRptRequest.RptRequest_ID
           t_sRptRequest.tc_Rowid       = tRptRequest.tc_Rowid
           t_sRptRequest.tc_ParentRowid = ""
           opPrimeKey                   = opPrimeKey + string(tRptRequest.RptRequest_ID).
end.