project QadFinancials > class BDebtorEndUser > method ApiDeleteEndUserForDebtor

Description

Deletes all debtorenduser recoreds for a Debtor specified in iiDebtorID.
The ValidateBC and AdditionalUpdates methods are called from here.

Finally the data is stored to the db (records deleted) using the DataSave method.


Parameters


iiDebtorIdinputintegerThe id value for the Debtor for which all DebtorEndUser's will be deleted.
ilIsKeepInstancesOpeninputlogical
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


QadFinancials
method BDebtor.AdditionalUpdates


program code (program3/bdebtorenduser.p)

assign vlIsKeepInstancesOpen = ilIsKeepInstancesOpen.

/* Find all endusers for the debtor specified by debtor_id and delete them. */
<M-1 run ClearData
   (output viFcReturnSuper (oiReturnStatus)) in BDebtorEndUser>

if viFcReturnSuper < 0 or
   oiReturnStatus  = 0
then assign oiReturnStatus = viFcReturnSuper.

if oiReturnStatus < 0
then return.

/* Get all debtor enduser id values for the passed in debtor_id. */
<Q-10 run DebtorEndUserByDebtor (all) (Read) (NoCache)
   (input viCompanyId, (CompanyId)
    input iiDebtorId, (DebtorId)
    output dataset tqDebtorEndUserByDebtor) in BDebtorEndUser >

/* Get all debtor enduser id values for the passed in debtor_id. */
for each tqDebtorEndUserByDebtor where 
         tqDebtorEndUserByDebtor.tiDebtor_ID = iiDebtorId:

    if vcList <> "":U
    then assign vcList = vcList + chr(4).
    assign vcList = vcList + string(tqDebtorEndUserByDebtor.tiDebtorEndUser_ID).

end. /* for each tqDebtorEndUserByDebtor. */

if vcList <> "":U
then do:
    /* Use Dataload to load all necessary debtor EndUser records identified in step one and delete them. */
    <M-8 run DataLoad
       (input  '':U (icRowids), 
        input  vcList (icPkeys), 
        input  '':U (icObjectIds), 
        input  '':U (icFreeform), 
        input  false (ilKeepPrevious), 
        output viFcReturnSuper (oiReturnStatus)) in BDebtorEndUser>
    
    if viFcReturnSuper <> 0 then assign oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0 then Return.
    
    /* For Each tDebtorEndUser run DataDelete */
    <M-9 run DataDelete
       (output viFcReturnSuper (oiReturnStatus)) in BDebtorEndUser>
    if viFcReturnSuper <> 0 then assign oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0 then Return.
    
    
    /* Run ValidateBC method check for errors and report to calling procedure. */
    <M-5 run ValidateBC
       (output viFcReturnSuper (oiReturnStatus)) in BDebtorEndUser>
    if viFcReturnSuper < 0 or oiReturnStatus  = 0
    then assign oiReturnStatus = viFcReturnSuper.
    if oiReturnStatus < 0
    then return.
    
    /* Run AdditionalUpdates metohd Check for errors and reprot to calling procedure.*/
    <M-6 run AdditionalUpdates
       (output viFcReturnSuper (oiReturnStatus)) in BDebtorEndUser>
    
    if viFcReturnSuper < 0 or
       oiReturnStatus  = 0
    then assign oiReturnStatus = viFcReturnSuper.
    
    if oiReturnStatus < 0
    then return.
    
    /* Run DataSave method. */
    <M-7 run DataSave
       (output viFcReturnSuper (oiReturnStatus)) in BDebtorEndUser>
    
    if viFcReturnSuper < 0 or
       oiReturnStatus  = 0
    then assign oiReturnStatus = viFcReturnSuper.
    
    if oiReturnStatus < 0
    then return.
end. /* If vcList <> "":U */


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 = "BDebtorEndUser".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiDeleteEndUserForDebtor".
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/bdebtorenduser.apideleteenduserfordebtor.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiDebtorId = <parameter value>
       vhParameter::ilIsKeepInstancesOpen = <parameter value>.

/* 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.