project QadFinancials > class BDebtor > method ApiStdMaintainTT
Parameters
| tApiDebtor | input | temp-table | |
| tApiDebtorSafDefault | input | temp-table | |
| icAction | input | character | |
| ocLstPrimKey | output | character | |
| ocLstReturn | output | character | |
| ocLstRowid | output | character | |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program6/bdebtor.p)
/* ========================================================= */
/* Method Info: Debtors (and their subinformation) will be */
/* Updated or Created based on the Logical or Physical Key */
/* ========================================================= */
/* ============================================================================ */
/* Clear the instance: */
/* this will also clear the t_s tables that were filled in ApiMaintainByDataSet */
/* ============================================================================ */
<M-29 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BDebtor>
if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.
if oiReturnStatus < 0
then return.
/* ==================== */
/* Set Default Return */
/* Parameter Validation */
/* ==================== */
assign oiReturnStatus = -98
vlDraftInstanceCreated = false.
if icAction = ? then assign icAction = "":U.
if icAction <> {&DAEMONACTION-SAVESTORE} and
icAction <> {&DAEMONACTION-SAVE} and
icAction <> {&DAEMONACTION-STORE} and
icAction <> {&DAEMONACTION-VALIDATE}
then do:
assign vcMessage = trim(subst(#T-34'Customer integration: the specified action (&1) should be in the list (&2).':255(71058)T-34#,trim(icAction),"{&DAEMONACTION-SAVESTORE},{&DAEMONACTION-SAVE},{&DAEMONACTION-STORE},{&DAEMONACTION-VALIDATE}":U))
oiReturnStatus = -1.
<M-17 run SetMessage (input vcMessage (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-923':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
return.
end. /* if icAction */
/* ====================== */
/* Count Debtor records */
/* ====================== */
for each tApiDebtor:
assign viMainTableRecordCount = viMainTableRecordCount + 1.
end. /* for each */
if viMainTableRecordCount = 0
then do:
assign vcMessage = trim(#T-35'Customer integration: no main table record found.':255(1672)T-35#)
oiReturnStatus = -1.
<M-18 run SetMessage (input vcMessage (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-924':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
return.
end. /* if viMainTableRecordCount = 0 */
/* ================================ */
/* Start loop on main-table records */
/* ================================ */
for each tApiDebtor by tApiDebtor.tc_Rowid:
MAIN-BLOCK: DO:
/* ========== */
/* Initialize */
/* ========== */
assign vcMessage = "":U
vcRowID = "":U
vlWarningsFound = false
vlSaveAsDraft = icAction = {&DAEMONACTION-STORE}.
/* ============================================ */
/* Get the Debtor_ID based on the logical key */
/* ============================================ */
if (tApiDebtor.Debtor_ID = ? or
tApiDebtor.Debtor_ID = 0) and
tApiDebtor.DebtorCode <> "" and
tApiDebtor.DebtorCode <> ?
then do:
<Q-30 run DebtorPrim (all) (Read) (NoCache)
(input viCompanyId, (CompanyId)
input tApiDebtor.DebtorCode, (DebtorCode)
input tApiDebtor.Debtor_ID, (Debtor_ID)
output dataset tqDebtorPrim) in BDebtor >
find tqDebtorPrim where
tqDebtorPrim.tcDebtorCode = tApiDebtor.DebtorCode
no-lock no-error.
if available tqDebtorPrim
then assign tApiDebtor.Debtor_ID = tqDebtorPrim.tiDebtor_ID.
end. /* if tApiDebtor.Debtor_ID = ? or */
/* ==================== */
/* Load/Create Debtor */
/* ==================== */
if tApiDebtor.Debtor_ID = ? or
tApiDebtor.Debtor_ID = 0
then assign viFcReturnSuper = -4.
else do:
<M-20 run DataLoad
(input '':U (icRowids),
input string(tApiDebtor.Debtor_ID) (icPkeys),
input '':U (icObjectIds),
input '' (icFreeform),
input false (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
end. /* if tApiDebtor.Debtor_ID = ? or */
if viFcReturnSuper = -4
then do:
assign viFcReturnSuper = 0.
<M-21 run DataNew (output viFcReturnSuper (oiReturnStatus)) in BDebtor>
if viFcReturnSuper < 0
then assign vcMessage = trim(subst(#T-36'Cannot create a new instance. Error number: &1.':255(308)t-36#, string(viFcReturnSuper))).
find first tDebtor no-error.
end. /* if viFcReturnSuper = -4 */
else do:
if viFcReturnSuper < 0
then assign vcMessage = trim(subst(#T-37'Cannot load the instance (error number: &1, instance ID: &2).':255(1436)t-37#,string(viFcReturnSuper),string(tApiDebtor.Debtor_ID))).
else do:
find tDebtor where
tDebtor.Debtor_ID = tApiDebtor.Debtor_ID
no-error.
if not available tDebtor
then assign vcMessage = trim(subst(#T-38'Cannot find the instance after it has been loaded (instance ID: &1).':255(290)t-38#,string(tApiDebtor.Debtor_ID))).
else assign tDebtor.tc_Status = "C":U.
end. /* Not if viFcReturnSuper < 0 */
end. /* Not if viFcReturnSuper = -4 */
/* ====================================== */
/* Check for errors in the previous block */
/* ====================================== */
if vcMessage <> "":U
then do:
assign ocLstReturn = ocLstReturn + chr(4) + (if viFcReturnSuper = 0 then "-3":U else string(viFcReturnSuper))
ocLstPrimKey = ocLstPrimKey + chr(4) + "*":U
ocLstRowid = ocLstRowid + chr(4) + "*":U
vlSaveAsDraft = false.
<M-22 run SetMessage (input vcMessage (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-925':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
leave MAIN-BLOCK.
end. /* if vcMessage <> "":U */
/* ====================== */
/* Copy data for Debtor */
/* ====================== */
buffer-copy tApiDebtor
except tApiDebtor.Debtor_ID
tApiDebtor.SharedSet_ID
tApiDebtor.tc_ParentRowid
tApiDebtor.tc_Rowid
tApiDebtor.tc_Status
tApiDebtor.DebtorCode
to tDebtor.
if tDebtor.tc_Status = "N":U
then assign tDebtor.DebtorCode = tApiDebtor.DebtorCode.
assign vcRowID = tDebtor.tc_Rowid
tApiDebtor.Debtor_ID = tDebtor.Debtor_ID /* Needed to set the prim-key after the Save */.
/* ============================================= */
/* Process all Child tables (CreditorSafDefault) */
/* ============================================= */
<M-32 run ApiStdMaintainTTDetail (input icAction (icAction),
input-output ocLstPrimKey (bcLstPrimKey),
input-output ocLstReturn (bcLstReturn),
input-output ocLstRowid (bcLstRowid),
input-output vlSaveAsDraft (blSaveAsDraft),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
if viFcReturnSuper < 0
then leave MAIN-BLOCK.
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
/* =================================================== */
/* This is where it ends if only SaveAsDraft is needed */
/* =================================================== */
if vlSaveAsDraft
then do:
assign ocLstReturn = ocLstReturn + chr(4) + "-1":U
ocLstPrimKey = ocLstPrimKey + chr(4) + "*":U
ocLstRowid = ocLstRowid + chr(4) + "*":U.
leave MAIN-BLOCK.
end. /* if vlSaveAsDraft */
/* =============================== */
/* Set Actvity */
/* =============================== */
if can-find (first tDebtor where
tDebtor.tc_Status = "N":U)
then assign vcActivityCode = "Create":U.
else if can-find (first tDebtor where
tDebtor.tc_Status = "C":U)
then assign vcActivityCode = "Modify":U.
/* ========================================= */
/* Validate the data & perform AddtionalUpd */
/* ========================================= */
<M-23 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BDebtor>
if viFcReturnSuper < 0
then do:
assign ocLstReturn = ocLstReturn + chr(4) + string(viFcReturnSuper)
ocLstPrimKey = ocLstPrimKey + chr(4) + "*":U
ocLstRowid = ocLstRowid + chr(4) + "*":U
vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and icAction <> {&DAEMONACTION-VALIDATE}).
leave MAIN-BLOCK.
end. /* if viFcReturnSuper <> 0 */
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
<M-24 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BDebtor>
if viFcReturnSuper < 0
then do:
assign ocLstReturn = ocLstReturn + chr(4) + string(viFcReturnSuper)
ocLstPrimKey = ocLstPrimKey + chr(4) + "*":U
ocLstRowid = ocLstRowid + chr(4) + "*":U
vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and icAction <> {&DAEMONACTION-VALIDATE}).
leave MAIN-BLOCK.
end. /* if viFcReturnSuper <> 0 */
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
/* ============= */
/* Save the data */
/* ============= */
if icAction <> {&DAEMONACTION-VALIDATE}
then do :
<M-25 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BDebtor>
if viFcReturnSuper < 0
then do:
assign ocLstReturn = ocLstReturn + chr(4) + string(viFcReturnSuper)
ocLstPrimKey = ocLstPrimKey + chr(4) + "*":U
ocLstRowid = ocLstRowid + chr(4) + "*":U
vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and icAction <> {&DAEMONACTION-VALIDATE}).
leave MAIN-BLOCK.
end. /* if viFcReturnSuper <> 0 */
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
end. /* if icAction = {&DAEMONACTION-VALIDATE} */
/* ============================================ */
/* Indicate that everything was saved correctly */
/* ============================================ */
assign ocLstReturn = ocLstReturn + chr(4) + (if vlWarningsFound = true then "1":U else "0":U)
ocLstPrimKey = ocLstPrimKey + chr(4) + string(tApiDebtor.Debtor_ID)
ocLstRowid = ocLstRowid + chr(4) + vcRowID.
END. /* MAIN-BLOCK */
/* ================================================================== */
/* Handle errors: Store if SaveAsDraft is needed */
/* Check: only 1 draft is allowed for a single bus-component instance */
/* ================================================================== */
if vlSaveAsDraft and
index(substring(ocLstReturn, r-index(ocLstReturn, chr(4)) + 1,-1,"CHARACTER":U),"-":U) <> 0 /* Negative return-status for this entry */
then do:
if vlDraftInstanceCreated = true
then do :
assign vcMessage = trim(#T-39'Only one draft instance can be created per method call.':255(858)T-39#) + chr(10) + trim(#T-40'This second object will not be stored as a draft instance and so is an error.':255(859)t-40#).
<M-31 run SetMessage (input vcMessage (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2886':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
next.
end. /* if vlDraftInstanceCreated = true */
<M-26 run StoreState
(input '(':U + tDebtor.DebtorCode + ') ':U + trim(#T-41'Customer created using an API method.':200(1673)T-41#) (icDescription),
input ? (icUIClass),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
assign vlDraftInstanceCreated = true
entry(num-entries(ocLstReturn , chr(4)), ocLstReturn , chr(4)) = string(viFcReturnSuper)
entry(num-entries(ocLstPrimKey, chr(4)), ocLstPrimKey, chr(4)) = string(tApiDebtor.Debtor_ID)
entry(num-entries(ocLstRowid , chr(4)), ocLstRowid , chr(4)) = vcRowID.
end. /* if vlSaveAsDraft and substr */
end. /* for each tApiDebtor: */
/* ============================================================ */
/* Trim the first character of ocLstReturn and primkey */
/* Check for correct number and format of the return-parameters */
/* ============================================================ */
if length(ocLstReturn,"CHARACTER":U) > 1 then assign ocLstReturn = substring(ocLstReturn,2,-1,"CHARACTER":U).
if length(ocLstPrimKey,"CHARACTER":U) > 1 then assign ocLstPrimKey = substring(ocLstPrimKey,2,-1,"CHARACTER":U).
if length(ocLstRowid,"CHARACTER":U) > 1 then assign ocLstRowid = substring(ocLstRowid,2,-1,"CHARACTER":U).
if num-entries(ocLstReturn,chr(4)) <> viMainTableRecordCount or
num-entries(ocLstPrimKey,chr(4)) <> viMainTableRecordCount or
num-entries(ocLstRowid,chr(4)) <> viMainTableRecordCount
then do :
assign vcMessage = trim(#T-42'Customer integration: incomplete information returned by an API method. See other messages for further details.':200(1674)T-42#) + chr(10) +
trim(substitute(#T-43'Main table records: &1.':255(310)T-43#,string(viMainTableRecordCount))) + chr(10) +
trim(substitute(#T-44'Return Statuses: &1.':255(311)T-44#,ocLstReturn)) + chr(10) +
trim(substitute(#T-45'Primary keys: &1.':255(312)T-45#,ocLstPrimKey)) + chr(10) +
trim(substitute(#T-46'Row IDs: &1.':255(313)T-46#,ocLstRowid)).
oiReturnStatus = -3.
<M-27 run SetMessage (input vcMessage (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-926':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
return.
end. /* if num-entries */
/* ===================================================== */
/* Set global return status based on the individual ones */
/* ===================================================== */
if ocLstReturn = substring(fill("0":U + CHR(4),viMainTableRecordCount),1,length(ocLstReturn,"CHARACTER":U),"CHARACTER":U)
then assign oiReturnStatus = 0.
else do :
if index(ocLstReturn,"-":U) <> 0
then do :
assign vcMessage = trim(#T-47'An error has occurred while running this API method. See other error messages for more details.':255(301)T-47#)
oiReturnStatus = -1.
<M-28 run SetMessage (input vcMessage (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-927':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
end. /* if index("-":U, ocLstReturn) <> 0 */
else do :
assign vcMessage = trim(#T-48'A warning has occurred while running this API method. See other error messages for more details.':255(302)T-48#)
oiReturnStatus = +1.
<M-33 run SetMessage (input vcMessage (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'W':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2887':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDebtor>
end. /* not if lookup */
end. /* not if ocLstReturn */
Sample code: how to call this method through RPCRequestService (QXtend Inbound)
define temp-table ttContext no-undo
field propertyQualifier as character
field propertyName as character
field propertyValue as character
index entityContext is primary unique
propertyQualifier
propertyName
index propertyQualifier
propertyQualifier.
define dataset dsContext for ttContext.
define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.
/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
ttContext.propertyValue = "BDebtor".
create ttContext.
assign ttContext.propertyName = "methodName"
ttContext.propertyValue = "ApiStdMaintainTT".
create ttContext.
assign ttContext.propertyName = "applicationId"
ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
ttContext.propertyValue = "".
/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bdebtor.apistdmaintaintt.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icAction = <parameter value>.
vhParameter = vhInputDS:get-buffer-handle("tApiDebtor").
vhParameter:buffer-create().
assign vhParameter::<field-name-1> = <field-value-1>
vhParameter::<field-name-2> = <field-value-2>
...
vhParameter = vhInputDS:get-buffer-handle("tApiDebtorSafDefault").
vhParameter:buffer-create().
assign vhParameter::<field-name-1> = <field-value-1>
vhParameter::<field-name-2> = <field-value-2>
...
/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").
if not vhServer:connected()
then do:
message "Could not connect AppServer" view-as alert-box error title "Error".
return.
end.
/* Run */
assign vhContextDS = dataset dsContext:handle.
run program/rpcrequestservice.p on vhServer
(input-output dataset-handle vhContextDS by-reference,
output dataset-handle vhExceptionDS,
input dataset-handle vhInputDS by-reference,
input-output dataset-handle vhInputOutputDS by-reference,
output dataset-handle vhOutputDS).
/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).
if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).
/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.
if valid-handle(vhInputDS)
then delete object vhInputDS.
if valid-handle(vhOutputDS)
then delete object vhOutputDS.
if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.