project QadFinancials > class BQBudgetActual > method ApiDeleteQBudgetLinkActual

Description

Method that will process QBudgetLinkActual--records based on the input paramter of this method. The QBudgetLinkActual records will be deleted and the update towards the BBudgetLink components will be provided in the AdditionalUpdates.


Parameters


iiQBudgetLinkActualIDinputintegerQBudgetLinkActualID
iiExternalDebugLevelinputintegerExternalDebugLevel
icExternalDebugDirectoryinputcharacterExternalDebugDirectory
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


QadFinancials
method BBudgetDaemonProcessor.PerformWorkItem


program code (program8/bqbudgetactual.p)

/*    
    /* ============= */
    /* State Logging */
    /* ============= */
    if iiExternalDebugLevel      > 0 and 
       iiExternalDebugLevel      < 4 and 
       icExternalDebugDirectory <> ? and 
       icExternalDebugDirectory <> "":U 
    then do :
        if substring(icExternalDebugDirectory,length(icExternalDebugDirectory,"CHARACTER":U),-1,"CHARACTER":U) <> "/":U and 
           substring(icExternalDebugDirectory,length(icExternalDebugDirectory,"CHARACTER":U),-1,"CHARACTER":U) <> "~\":U
        then assign icExternalDebugDirectory = icExternalDebugDirectory + "/":U.
        <I-11 {bFcOpenInstance
            &CLASS           = "Session"}>
        <M-12 run SetIntegerValue (input  'viDebugLevel':U (icName), 
                          input  iiExternalDebugLevel (iiValue), 
                          output viFcReturnSuper (oiReturnStatus)) in Session>
        <M-13 run SetCharacterValue (input  'vcDebugDirectory':U (icName), 
                             input  icExternalDebugDirectory (icValue), 
                             output viFcReturnSuper (oiReturnStatus)) in Session>
        if viFcReturnSuper = 0 
        then assign viDebugLevel     = iiExternalDebugLevel
                    vcDebugDirectory = icExternalDebugDirectory.                             
        <I-14 {bFcCloseInstance
            &CLASS           = "Session"}>
    end. /* if iiExternalDebugLevel      > 0 and */
      */
    /* ================================================================ */
    /* Return if no data is passed                                      */
    /* ================================================================ */
    if iiQBudgetLinkActualID = 0 or 
       iiQBudgetLinkActualID = ?
    then return.
    
    /* ================================================================ */
    /* Set Return-status = Default-error                                */
    /* ================================================================ */
    assign oiReturnStatus = -98.
    
    /* ================================================================ */
    /* Empty the instance                                               */
    /* ================================================================ */
    <M-1 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    
    /* ================================================================ */
    /* Load the data / Find the record and mark as deleted              */
    /* ================================================================ */
    <M-9 run DataLoad
          (input  '':U (icRowids), 
           input  string(iiQBudgetLinkActualID) (icPkeys), 
           input  '':U (icObjectIds), 
           input  '' (icFreeform), 
           input  false (ilKeepPrevious), 
           output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    find tQBudgetLinkActual where
         tQBudgetLinkActual.QBudgetLinkActual_ID = iiQBudgetLinkActualID
         no-error.
    if not available tQBudgetLinkActual
    then do :
        assign vcMessage      = trim(substitute(#T-15'The system cannot find record for processing the budget actuals (internal ID: &1).':255(3454)t-15#,string(iiQBudgetLinkActualID)))
               oiReturnStatus = -3.
        <M-10 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-1748':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
        return.
    end. /* if not available tQBudgetLinkActual */
    assign tQBudgetLinkActual.tc_Status = "D":U.
     
    /* ================================================================ */
    /* Perfom Validation, AdditionalUpdates and DataSave                */
    /* ================================================================ */
    <M-6 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    <M-7 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    <M-8 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    
    /* ================================================================ */
    /* Set Return-status = OK                                           */
    /* ================================================================ */
    if oiReturnStatus = -98
    then assign oiReturnStatus = 0.


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 = "BQBudgetActual".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiDeleteQBudgetLinkActual".
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/bqbudgetactual.apideleteqbudgetlinkactual.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiQBudgetLinkActualID = <parameter value>
       vhParameter::iiExternalDebugLevel = <parameter value>
       vhParameter::icExternalDebugDirectory = <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.