method ApiGetDefaultPeriodDate

Description

This method has two functionalities, depending on the input parameters:

- system will default posting date based on selected year/period
(YearIn <> 0, YearIn <> ?, PeriodIn <> ?)

- system will default accounting year/period based on selected posting date
(DateIn <> ?)

Please Note: Zero Accounting Period is also valid (for Year Opening)

It this the purpose that this method is not called from within our own application.
This Api-method is a wrapper towards method BPeriod.GetDefaultPeriodDate. (it has the same interface)

Parameters

iiYearIn	input	integer	Year field as input parameter.
iiPeriodIn	input	integer	Period field as Input parameter.
itDateIn	input	date	Date as input parameter.
ilOpenForPurchase	input	logical	Open For Purchase Values: ----------- no - the returned period should be closed for purchase yes - the returned period should be open for purchase ? - the purchase status does not matter
ilOpenForSales	input	logical	Open For Sales. Values: ----------- no - the returned period should be closed for sales yes - the returned period should be open for sales ? - the sales status does not matter
ilOpenForInventory	input	logical	Open For Inventory Values: ----------- no - the returned period should be closed for inventory yes - the returned period should be open for inventory ? - the inventory status does not matter
oiYear	output	integer	Year as output parameter.
oiPeriod	output	integer	Period as output parameter.
otPostingDate	output	date	Accounting Posting Date
oiReturnStatus	output	integer	Return status of the method.

Internal usage

QadFinancials

method BPosting.ApiStdMaintainMultiTT
method BPaymentSelection.DefaultValuesForApiConfirm

program code (program3/bperiod.p)

<M-1 run GetDefaultPeriodDate (input  iiYearIn (iiYearIn), 
                               input  iiPeriodIn (iiPeriodIn), 
                               input  itDateIn (itDateIn), 
                               input  ilOpenForPurchase (ilOpenForPurchase), 
                               input  ilOpenForSales (ilOpenForSales), 
                               input  ilOpenForInventory (ilOpenForInventory), 
                               output oiYear (oiYear), 
                               output oiPeriod (oiPeriod), 
                               output otPostingDate (otPostingDate), 
                               output viFcReturnSuper (oiReturnStatus)) in BPeriod>
                               
assign oiReturnStatus = viFcReturnSuper.

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 = "BPeriod".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetDefaultPeriodDate".
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/bperiod.apigetdefaultperioddate.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiYearIn = <parameter value>
       vhParameter::iiPeriodIn = <parameter value>
       vhParameter::itDateIn = <parameter value>
       vhParameter::ilOpenForPurchase = <parameter value>
       vhParameter::ilOpenForSales = <parameter value>
       vhParameter::ilOpenForInventory = <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.