method ExitInstance

Description

This method can be extended with code to execute when an instance of a business class is stopped.

Standard functionality in this method is
- Clean up instance data in the fcInstance table.
- Create or update a draft instance if applicable.

plus transaction handling
- Remove the instance from the transaction if it was added to a transaction in InitInstance.
- Abort the transaction if one was started from inside the business code.

PreCondition

This method is executed when :
- A business instance is stopped (release object + delete instance data)
(icDraftReference = "" + viCurrentDraftInstanceId = 0)
- A business instance is saved as a draft (release object + create draft)
(icDraftReference <> "")
- A draft instance is stopped (release object, delete copy of draft, release original draft)
(icDraftReference = "" + viCurrentDraftInstanceId <> 0)

This method is NOT run when a business instance is only closed (release object + keep instance data).

Parameters

icDraftReference	input	character	Description for the draft instance. This parameter will have a value when creating a draft instance.
icDraftFormName	input	character	This parameter will have a value when creating a draft instance.
ilDraftIsShared	input	logical	This parameter will have a value when creating a draft instance.
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program/bddocument.p)

<ANCESTOR-CODE>

if viCurrentDraftInstanceId = 0
then for each tDDocument where
         tDDocument.tc_Status        = "N":U and
         tDDocument.DDocumentNumber <> 0     and
         tDDocument.DDocumentNumber <> ?:
    assign vhFcComponent = ?.

    if icDraftReference = "":U
    then do:
        <M-1 run ReleaseNumber
           (input  tDDocument.Company_ID (iiCompanyId), 
            input  tDDocument.DDocumentYear (iiNumbrYear), 
            input  'D':U + tDDocument.DDocumentType (icNumbrType), 
            input  tDDocument.DDocumentNumber (iiNumbr), 
            input  viFcCurrentInstanceId (iiInstanceId), 
            input  vcFcComponentName (icClassName), 
            output viFcReturnSuper (oiReturnStatus)) in BNumber>
    end.
    else do:
        <M-2 run StoreNumber (input  tDDocument.Company_ID (iiCompanyID), 
                      input  tDDocument.DDocumentYear (iiNumbrYear), 
                      input  'D':U + tDDocument.DDocumentType (icNumbrType), 
                      input  tDDocument.DDocumentNumber (iiNumbr), 
                      output viFcReturnSuper (oiReturnStatus)) in BNumber>
    end.

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

    if oiReturnStatus < 0
    then return.
end.