project QadFinancials > class BCountry > method ApiStdMaintainTT
Description
Integration point for add/change/delete
Parameters
| tApiCountry | input | temp-table | Countries' to create/update |
| tApiCountryVatFormat | input | temp-table | Country Vat Format's to create/update |
| icAction | input | character | This input parameter defines what should happen with the input data: - SAVE: Save the data if there were no errors. - SAVESTORE: Save the data if there were no errors. If there were, save as draft. - STORE: Save the data as draft. - VALIDATE: Validate the input data, but do not save the data. |
| ocLstPrimKey | output | character | Char4 separated list with the primary keys of the newly created main-table records. The fields of a primkey are separated with Char2. E.g. 1<Char2>2002<Char2>100<Char4>1<Char2>2002<Char2>101 |
| ocLstReturn | output | character | Char4 separated list with the return-status of the newly created main-table records. Zero means no errors occured. E.g. 0<Char4>-1<Char4>-504<Char4>1<Char4>0 |
| ocLstRowid | output | character | Char4 separated list with the temporarely rowids (negative for new ones) of the newly created main-table records. . E.g. -1<Char2>aox00098001<Char2>-26 |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program7/bcountry.p)
/* =================================================== */
/* Method Info: */
/* Country will be loaded based on the Logical Key */
/* =================================================== */
/* ============================================================================ */
/* Clear the instance: */
/* this will also clear the t_s tables that were filled in ApiMaintainByDataSet */
/* ============================================================================ */
<M-4 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BCountry>
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 vcCountryMsg = trim(subst(#T-19'A country integration error occurred. The specified action (&1) must be in the list '&2'.':255(1410)t-19#,trim(icAction),"{&DAEMONACTION-SAVESTORE},{&DAEMONACTION-SAVE},{&DAEMONACTION-STORE},{&DAEMONACTION-VALIDATE}":U))
oiReturnStatus = -1.
<M-1 run SetMessage (input vcCountryMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2559':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
return.
end. /* if icAction */
/* ======================== */
/* Count main-table records */
/* ======================== */
for each tApiCountry no-lock :
assign viMainTableRecordCount = viMainTableRecordCount + 1.
end. /* for each */
if viMainTableRecordCount = 0
then do:
assign vcCountryMsg = trim(#T-20'A country integration error occurred. The system could not find main table records (Country).':255(1411)t-20#)
oiReturnStatus = -1.
<M-2 run SetMessage (input vcCountryMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2560':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
return.
end. /* if viMainTableRecordCount */
/* ========================= */
/* Start Queries */
/* ========================= */
<Q-3 run CountryPrim (Start) in BCountry >
/* ================================ */
/* Start loop on main-table records */
/* ================================ */
for each tApiCountry by tApiCountry.tc_Rowid :
MAIN-BLOCK: DO:
/* ========== */
/* Initialize */
/* ========== */
assign vcCountryMsg = "":U
vcRowID = "":U
vlWarningsFound = false
vlSaveAsDraft = icAction = {&DAEMONACTION-STORE}.
/* =========================================== */
/* Get the Country_ID based on the logical key */
/* =========================================== */
if (tApiCountry.Country_ID = ? or
tApiCountry.Country_ID = 0) and
tApiCountry.CountryCode <> "" and
tApiCountry.CountryCode <> ?
then do:
<Q-5 run CountryPrim (all) (Read) (NoCache)
(input tApiCountry.Country_ID, (CountryId)
input tApiCountry.CountryCode, (CountryCode)
output dataset tqCountryPrim) in BCountry >
find tqCountryPrim where
tqCountryPrim.tcCountryCode = tApiCountry.CountryCode
no-lock no-error.
if available tqCountryPrim
then assign tApiCountry.Country_ID = tqCountryPrim.tiCountry_ID.
end.
/* ==================== */
/* Load/Create Country */
/* ==================== */
if tApiCountry.Country_ID = ? or
tApiCountry.Country_ID = 0
then assign viFcReturnSuper = -4.
else do:
<M-6 run DataLoad (input ? (icRowids),
input string(tApiCountry.Country_ID) (icPkeys),
input ? (icObjectIds),
input ? (icFreeform),
input false (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
end. /* Not if tApiCountry.Country_ID = ? or */
if viFcReturnSuper = -4
then do:
assign viFcReturnSuper = 0.
<M-7 run DataNew (output viFcReturnSuper (oiReturnStatus)) in BCountry>
if viFcReturnSuper < 0
then assign vcCountryMsg = trim(subst(#T-21'Cannot create a new instance. Error number: &1.':255(308)t-21#, string(viFcReturnSuper))).
find first tCountry no-error.
end. /* if viFcReturnSuper = -4 */
else do:
if viFcReturnSuper < 0
then assign vcCountryMsg = trim(subst(#T-22'Cannot load the instance (error number: &1, instance ID: &2).':255(289)t-22#, string(viFcReturnSuper), string(tApiCountry.Country_ID))).
else do:
find tCountry where
tCountry.Country_ID = tApiCountry.Country_ID
no-error.
if not available tCountry
then assign vcCountryMsg = trim(subst(#T-23'Cannot find the instance after it has been loaded (instance ID: &1).':255(290)t-23#,string(tApiCountry.Country_ID))).
else assign tCountry.tc_Status = "C":U.
end. /* Not if viFcReturnSuper <> 0 */
end. /* Not if viFcReturnSuper = -4 */
/* ====================================== */
/* Check for errors in the previous block */
/* ====================================== */
if vcCountryMsg <> "":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-17 run SetMessage (input vcCountryMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2587':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
leave MAIN-BLOCK.
end. /* if vcMessage <> "":U */
/* ====================== */
/* Copy data for Country */
/* ====================== */
buffer-copy tApiCountry
except tApiCountry.Country_ID
tApiCountry.tc_ParentRowid
tApiCountry.tc_Rowid
tApiCountry.tc_Status
tApiCountry.CountryCode
to tCountry.
if tCountry.tc_Status = "N":U
then assign tCountry.CountryCode = tApiCountry.CountryCode.
assign vcRowID = tCountry.tc_Rowid
tApiCountry.Country_ID = tCountry.Country_ID /* Needed to set the prim-key after the Save */.
/* =========================================== */
/* Process all Child tables (CountryVatFormat) */
/* =========================================== */
<M-8 run ApiStdMaintainTTDetail (input icAction (icaction),
input-output ocLstReturn (bcLstReturn),
input-output ocLstPrimKey (bcLstPrimKey),
input-output ocLstRowid (bcLstRowid),
input-output vlSaveAsDraft (blSaveAsDraft),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
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 & Validate the data */
/* =============================== */
if can-find (first tCountry where
tCountry.tc_Status = "N":U)
then assign vcActivityCode = "Create":U.
else if can-find (first tCountry where
tCountry.tc_Status = "C":U)
then assign vcActivityCode = "Modify":U.
<M-9 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BCountry>
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.
/* ================ */
/* External updates */
/* ================ */
<M-10 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BCountry>
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-11 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BCountry>
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(tApiCountry.Country_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(substr(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 vcCountryMsg = trim(#T-24'Only one draft instance can be created per method call.':255(858)T-24#) + chr(10) + trim(#T-25'This second object will not be stored as a draft instance and so is an error.':255(859)t-25#).
<M-18 run SetMessage (input vcCountryMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2850':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
next.
end. /* if vlDraftInstanceCreated = true */
<M-12 run StoreState (input '(':U + string(tCountry.CountryCode) + ') ':U + trim(#T-26'The country was created using an API method.':200(1412)t-26#) (icDescription),
input ? (icUIClass),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
assign vlDraftInstanceCreated = true
entry(num-entries(ocLstReturn , chr(4)), ocLstReturn , chr(4)) = string(viFcReturnSuper)
entry(num-entries(ocLstPrimKey, chr(4)), ocLstPrimKey, chr(4)) = string(tApiCountry.Country_ID)
entry(num-entries(ocLstRowid , chr(4)), ocLstRowid , chr(4)) = vcRowID.
end. /* if vlSaveAsDraft and substr */
end. /* for each tApiCountry: */
/* ========================= */
/* Stop Queries */
/* ========================= */
<Q-13 run CountryPrim (Stop) in BCountry >
/* ============================================================ */
/* 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 vcCountryMsg = trim(#T-27'A country integration error occurred. An API method returned incomplete information. See other messages for further details.':200(1413)t-27#) + chr(10) +
trim(substitute(#T-28'Main table records: &1.':255(310)T-28#,string(viMainTableRecordCount))) + chr(10) +
trim(substitute(#T-29'Return Statuses: &1.':255(311)T-29#,ocLstReturn)) + chr(10) +
trim(substitute(#T-30'Primary keys: &1.':255(312)T-30#,ocLstPrimKey)) + chr(10) +
trim(substitute(#T-31'Row IDs: &1.':255(313)T-31#,ocLstRowid)).
oiReturnStatus = -3.
<M-16 run SetMessage (input vcCountryMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2584':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
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 vcCountryMsg = trim(#T-32'An error has occurred while running this API method. See other error messages for more details.':255(301)T-32#)
oiReturnStatus = -1.
<M-15 run SetMessage (input vcCountryMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2583':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
end. /* index(ocLstReturn,"-":U) <> 0 */
else do :
assign vcCountryMsg = trim(#T-33'A warning has occurred while running this API method. See other error messages for more details.':255(302)T-33#)
oiReturnStatus = +1.
<M-14 run SetMessage (input vcCountryMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'W':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2582':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BCountry>
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 = "BCountry".
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/bcountry.apistdmaintaintt.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icAction = <parameter value>.
vhParameter = vhInputDS:get-buffer-handle("tApiCountry").
vhParameter:buffer-create().
assign vhParameter::<field-name-1> = <field-value-1>
vhParameter::<field-name-2> = <field-value-2>
...
vhParameter = vhInputDS:get-buffer-handle("tApiCountryVatFormat").
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.