project QadFinancials > class BReportPeriod > method APIGetStartAndEndDate

Description

This method will retrieve the start date and end date from the specific year and period.


Parameters


iiReportPeriodYearinputintegerSpecific Year
iiReportPeriodPeriodinputintegerSpecific Period
ilSetMessageinputlogicalIndicates whether we want to get errors/warnings (TRUE) or not (FALSE)
otStartDateoutputdateStart date of the specific report period
otEndDateoutputdateEnd date of the specific report period
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program3/breportperiod.p)

if iiReportPeriodYear   = 0 or
   iiReportPeriodYear   = ? or
   iiReportPeriodPeriod = 0 or
   iiReportPeriodPeriod = ?
then return.
   
<Q-1 run ReportPeriodByAllInfo (all) (Read) (NoCache)
          (input ?, (ReportPeriodID)
           input iiReportPeriodYear, (ReportPeriodYear)
           input iiReportPeriodPeriod, (ReportPeriodPeriod)
           input ?, (ReportPeriodStartDate)
           input ?, (ReportPeriodEndDate)
           input ?, (ReportPeriodIsReported)
           output dataset tqReportPeriodByAllInfo) in BReportPeriod >
find first tqReportPeriodByAllInfo where 
    tqReportPeriodByAllInfo.tiReportPeriodYear = iiReportPeriodYear and
    tqReportPeriodByAllInfo.tiReportPeriodPeriod = iiReportPeriodPeriod
    no-error.
if available tqReportPeriodByAllInfo
then assign otStartDate = tqReportPeriodByAllInfo.ttReportPeriodStartDate
            otEndDate   = tqReportPeriodByAllInfo.ttReportPeriodEndDate.
else if ilSetMessage
then do:
    assign vcMessage      = trim(substitute(#T-3'The reporting period: &1/&2 is not defined in the system.':200(3548)t-3#,
                                string(iiReportPeriodYear),
                                string(iiReportPeriodPeriod)))
           oiReturnStatus = if oiReturnStatus <> 0 
                            then oiReturnStatus
                            else 1.
    <M-2 run SetMessage (input  vcMessage (icMessage),
                     input  '':U (icArguments),
                     input  '':U (icFieldName),
                     input  '':U (icFieldValue),
                     input  'W':U (icType),
                     input  3 (iiSeverity),
                     input  '':U (icRowid),
                     input  'QADFIN-2079':U (icFcMsgNumber),
                     input  '' (icFcExplanation),
                     input  '' (icFcIdentification),
                     input  '' (icFcContext),
                     output viFcReturnSuper (oiReturnStatus)) in BReportPeriod>    
end.


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 = "BReportPeriod".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "APIGetStartAndEndDate".
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/breportperiod.apigetstartandenddate.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiReportPeriodYear = <parameter value>
       vhParameter::iiReportPeriodPeriod = <parameter value>
       vhParameter::ilSetMessage = <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.